relaton-xsf 1.14.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57967099fd01cd6118a6af5300a6e64e02f4e9469dec76a856b6e34be6aa744e
+  data.tar.gz: b1d20c686eca06489fb63cc9e7a651c8fc58a36b0b86564587d259f78fff679a
+SHA512:
+  metadata.gz: 159d02d559ae64e01e86be9b0742a2cf4b8c87a280146e8aa40152de5dbf70e92bba9fdc23b3ebd6586259b4862528f9343ede2ff3d5ccce11f8d5fb853201f0
+  data.tar.gz: 37014f915743509729b8d19aed0a0294ef0d9c7fadabd754fde0da0b6376f1bab0c2a36d8cb81e86d30b017f72904a1d4c4c05c70c3e5b78f930c94dea9fc9d5

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+# This project follows the Ribose OSS style guide.
+# https://github.com/riboseinc/oss-guides
+# All project-specific additions and overrides should be specified in this file.
+
+require: rubocop-rails
+
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+AllCops:
+  TargetRubyVersion: 2.7
+Rails:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in relaton_xsf.gemspec
+gemspec
+
+gem "equivalent-xml", "~> 0.6"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"
+gem "rubocop-performance", "~> 1.11"
+gem "rubocop-rails", "~> 2.0"
+gem "simplecov", "~> 0.22"
+gem "vcr", "~> 6.0"
+gem "webmock", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2018, Ribose
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -0,0 +1,138 @@
+= Relaton-XSF: bibliographic retrieval of XMPP XEP specifications
+
+image:https://img.shields.io/gem/v/relaton-xsf.svg["Gem Version", link="https://rubygems.org/gems/relaton-xsf"]
+image:https://github.com/relaton/relaton-xsf/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/relaton/relaton-xsf/actions?workflow=macos"]
+image:https://github.com/relaton/relaton-xsf/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/relaton/relaton-xsf/actions?workflow=windows"]
+image:https://github.com/relaton/relaton-xsf/workflows/ubuntu/badge.svg["Build Status (Ubuntu)", link="https://github.com/relaton/relaton-xsf/actions?workflow=ubuntu"]
+image:https://codeclimate.com/github/relaton/relaton-xsf/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/relaton/relaton-xsf"]
+image:https://img.shields.io/github/issues-pr-raw/relaton/relaton-xsf.svg["Pull Requests", link="https://github.com/relaton/relaton-xsf/pulls"]
+image:https://img.shields.io/github/commits-since/relaton/relaton-xsf/latest.svg["Commits since latest",link="https://github.com/relaton/relaton-xsf/releases"]
+
+== Purpose
+
+`relaton-xsf` provides bibliographic information of XMPP XEP specifications using the
+https://github.com/relaton/relaton-models#the-relaton-bibliographic-models[BibliographicItem model].
+
+== Data sources
+
+Relaton-XSF retrieves bibliographic information from https://xmpp.org/extensions/refs/[XMPP dataset].
+
+The XSF Library dataset provides documents listed in the https://github.com/relaton/relaton-data-xsf/blob/main/index-v1.yaml[index].
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'relaton-xsf'
+----
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install relaton-xsf
+
+== Usage
+
+=== Search for a standard using keywords
+
+[source,ruby]
+----
+require 'relaton_xsf'
+=> true
+
+hit_collection = RelatonXsf::Bibliography.search("XEP 0001")
+=> <RelatonXsf::HitCollection:0x00000000019780 @ref=XEP 0001 @fetched=false>
+
+item = hit_collection[0].fetch
+=> #<RelatonXsf::BibliographicItem:0x000000011167a518
+ ...
+----
+
+=== XML serialization
+[source,ruby]
+----
+item.to_xml
+=> "<bibitem id="XEP0001" type="standard" schema-version="v1.2.3">
+      <fetched>2023-07-18</fetched>
+      <title format="text/plain" language="en" script="Latn">XMPP Extension Protocols</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.3">
+      <fetched>2023-07-18</fetched>
+      <title format="text/plain" language="en" script="Latn">XMPP Extension Protocols</title>
+      ...
+      <ext>
+        <doctype>rfc</doctype>
+      </ext>
+  </bibdata>"
+----
+
+=== Get document by reference
+[source,ruby]
+----
+item = RelatonXsf::Bibliography.get "XEP 0001"
+[relaton-xsf] (XEP 0001) fetching...
+[relaton-xsf] (XEP 0001) found XEP 0001
+=> #<RelatonXsf::BibliographicItem:0x000000011275cd18
+...
+
+item.docidentifier.first.id
+=> "XEP 0001"
+----
+
+=== Typed links
+
+XSF publications have `src` type link.
+
+[source,ruby]
+----
+item.link
+=> [#<RelatonBib::TypedUri:0x0000000113ad5ca0
+  @content=#<Addressable::URI:0xcc24 URI:http://xmpp.org/extensions/xep-0001.html>,
+  @language=nil,
+  @script=nil,
+  @type="src">]
+----
+
+=== Fetch data
+
+This gem uses the https://xmpp.org/extensions/refs/ dataset as a data source.
+
+The method `RelatonXsf::DataFetcher.fetch(output: "data", format: "yaml")` fetches all the documents from the dataset and saves them to the `./data` folder in YAML format.
+Arguments:
+
+- `output` - folder to save documents (default './data').
+- `format` - the format in which the documents are saved. Possible formats are: `yaml`, `xml`, `bibxxml` (default `yaml`).
+
+[source,ruby]
+----
+RelatonXsf::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
+----
+
+== Development
+
+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.
+
+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 https://rubygems.org[rubygems.org].
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/metanorma/relaton-xsf.
+
+== License
+
+The gem is available as open source under the terms of the https://opensource.org/license/bsd-2-clause/[2-Clause BSD License].

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec]

data/lib/relaton_xsf/bibliographic_item.rb

@@ -0,0 +1,4 @@
+module RelatonXsf
+  class BibliographicItem < RelatonBib::BibliographicItem
+  end
+end

data/lib/relaton_xsf/bibliography.rb

@@ -0,0 +1,22 @@
+module RelatonXsf
+  module Bibliography
+    extend self
+
+    def search(ref)
+      HitCollection.new(ref).search
+    end
+
+    def get(code, _year = nil, _opts = {})
+      warn "[relaton-xsf] (#{code}) fetching..."
+      result = search(code)
+      if result.empty?
+        warn "[relaton-xsf] (#{code}) nothing found"
+        return
+      end
+
+      bib = result.first.fetch
+      warn "[relaton-xsf] (#{code}) found #{bib.docidentifier.first.id}"
+      bib
+    end
+  end
+end

data/lib/relaton_xsf/bibxml_parser.rb

@@ -0,0 +1,12 @@
+module RelatonXsf
+  module BibXMLParser
+    include RelatonBib::BibXMLParser
+    extend self
+
+    # @param item_hash [Hash]
+    # @return [RelatonXsf::BibliographicItem]
+    def bib_item(item_hash)
+      BibliographicItem.new(**item_hash)
+    end
+  end
+end

data/lib/relaton_xsf/data_fetcher.rb

@@ -0,0 +1,57 @@
+module RelatonXsf
+  class DataFetcher
+    # @param output [String]
+    # @param format [String]
+    def initialize(output, format)
+      @output = output
+      @format = format
+      @ext = format.sub(/^bib/, "")
+      @files = []
+    end
+
+    def self.fetch(output: "data", format: "yaml")
+      warn "[relaton-xsf] fetching data to #{output} in #{format} format"
+      t1 = Time.now
+      warn "[relaton-xsf] start at #{t1}"
+      FileUtils.mkdir_p output
+      new(output, format).fetch
+      t2 = Time.now
+      t = t2 - t1
+      warn "[relaton-xsf] finished at #{t2} (#{t.round} seconds)"
+    end
+
+    def index
+      @index ||= Relaton::Index.find_or_create :xsf, file: "index-v1.yaml"
+    end
+
+    def fetch
+      agent = Mechanize.new
+      resp = agent.get "https://xmpp.org/extensions/refs/"
+      resp.xpath("//a[contains(@href, 'XEP-')]").each do |link|
+        doc = agent.get link[:href]
+        bib = BibXMLParser.parse doc.body
+        write_doc bib
+      end
+      index.save
+    end
+
+    def write_doc(bib)
+      id = bib.docidentifier.find(&:primary).id
+      file = File.join @output, "#{id.gsub(' ', '-').downcase}.#{@ext}"
+      if @files.include? file
+        warn "[relaton-xsf] WARNING: #{file} already exists"
+      end
+      File.write file, serialize(bib), encoding: "UTF-8"
+      @files << file
+      index.add_or_update id, file
+    end
+
+    def serialize(bib)
+      case @format
+      when "yaml" then bib.to_hash.to_yaml
+      when "xml" then bib.to_xml bibdata: true
+      else bib.send "to_#{@format}"
+      end
+    end
+  end
+end

data/lib/relaton_xsf/hash_converter.rb

@@ -0,0 +1,11 @@
+module RelatonXsf
+  class HashConverter < RelatonBib::HashConverter
+    class << self
+      # @param item_hash [Hash]
+      # @return [RelatonBib::BibliographicItem]
+      def bib_item(item_hash)
+        BibliographicItem.new(**item_hash)
+      end
+    end
+  end
+end

data/lib/relaton_xsf/hit.rb

@@ -0,0 +1,15 @@
+module RelatonXsf
+  class Hit < RelatonBib::Hit
+    def fetch
+      return @doc if @doc
+
+      agent = Mechanize.new
+      resp = agent.get hit[:url]
+      hash = YAML.safe_load resp.body
+      hash["fetched"] = Date.today.to_s
+      @doc = BibliographicItem.from_hash hash
+    rescue StandardError => e
+      raise RelatonBib::RequestError, e.message
+    end
+  end
+end

data/lib/relaton_xsf/hit_collection.rb

@@ -0,0 +1,19 @@
+module RelatonXsf
+  class HitCollection < RelatonBib::HitCollection
+    INDEX_FILE = "index-v1.yaml".freeze
+    GHDATA_URL = "https://raw.githubusercontent.com/relaton/relaton-data-xsf/main/".freeze
+
+    def search
+      @array = index.search(text).sort_by { |hit| hit[:id] }.map do |row|
+        Hit.new url: "#{GHDATA_URL}#{row[:file]}"
+      end
+      self
+    rescue StandardError => e
+      raise RelatonBib::RequestError, e.message
+    end
+
+    def index
+      @index ||= Relaton::Index.find_or_create :xsf, url: "#{GHDATA_URL}index-v1.zip", file: INDEX_FILE
+    end
+  end
+end

data/lib/relaton_xsf/processor.rb

@@ -0,0 +1,61 @@
+require "relaton/processor"
+
+module RelatonXsf
+  class Processor < Relaton::Processor
+    attr_reader :idtype
+
+    def initialize # rubocop:disable Lint/MissingSuper
+      @short = :relaton_xsf
+      @prefix = "XEP"
+      @defaultprefix = %r{^XEP\s}
+      @idtype = "XEP"
+      @datasets = %w[xep-xmpp]
+    end
+
+    # @param code [String]
+    # @param date [String, nil] year
+    # @param opts [Hash]
+    # @return [RelatonXsf::BibliographicItem]
+    def get(code, date, opts)
+      ::RelatonXsf::Bibliography.get(code, date, opts)
+    end
+
+    #
+    # Fetch all the documents from http://xml2rfc.tools.ietf.org/public/rfc/bibxml-3gpp-new/
+    #
+    # @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)
+      ::RelatonXsf::DataFetcher.fetch(**opts)
+    end
+
+    # @param xml [String]
+    # @return [RelatonXsf::BibliographicItem]
+    def from_xml(xml)
+      ::RelatonXsf::XMLParser.from_xml xml
+    end
+
+    # @param hash [Hash]
+    # @return [RelatonXsf::BibliographicItem]
+    def hash_to_bib(hash)
+      item_hash = ::RelatonXsf::HashConverter.hash_to_bib(hash)
+      ::RelatonXsf::BibliographicItem.new(**item_hash)
+    end
+
+    # Returns hash of XML grammar
+    # @return [String]
+    def grammar_hash
+      @grammar_hash ||= ::RelatonBib.grammar_hash
+    end
+
+    #
+    # Remove index file
+    #
+    def remove_index_file
+      Relaton::Index.find_or_create(:xsf, url: true, file: HitCollection::INDEX_FILE).remove_file
+    end
+  end
+end

data/lib/relaton_xsf/version.rb

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

data/lib/relaton_xsf/xml_parser.rb

@@ -0,0 +1,14 @@
+module RelatonXsf
+  class XMLParser < RelatonBib::XMLParser
+    #
+    # Create bibliographic item
+    #
+    # @param item_hash [Hash] bibliographic item hash
+    #
+    # @return [RelatonXsf::BibliographicItem] bibliographic item
+    #
+    def self.bib_item(item_hash)
+      BibliographicItem.new(**item_hash)
+    end
+  end
+end

data/lib/relaton_xsf.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "mechanize"
+require "relaton/index"
+require "relaton_bib"
+require_relative "relaton_xsf/version"
+require_relative "relaton_xsf/bibliographic_item"
+require_relative "relaton_xsf/bibliography"
+require_relative "relaton_xsf/hit_collection"
+require_relative "relaton_xsf/hit"
+require_relative "relaton_xsf/xml_parser"
+require_relative "relaton_xsf/bibxml_parser"
+require_relative "relaton_xsf/hash_converter"
+require_relative "relaton_xsf/data_fetcher"
+
+module RelatonXsf
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/relaton_xsf.rbs

@@ -0,0 +1,4 @@
+module RelatonXsf
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: relaton-xsf
+version: !ruby/object:Gem::Version
+  version: 1.14.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: relaton-bib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+- !ruby/object:Gem::Dependency
+  name: relaton-index
+  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
+description: 'RelatonIso: retrieve ISO Standards for bibliographic use using the IsoBibliographicItem
+  model'
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.adoc
+- Rakefile
+- lib/relaton_xsf.rb
+- lib/relaton_xsf/bibliographic_item.rb
+- lib/relaton_xsf/bibliography.rb
+- lib/relaton_xsf/bibxml_parser.rb
+- lib/relaton_xsf/data_fetcher.rb
+- lib/relaton_xsf/hash_converter.rb
+- lib/relaton_xsf/hit.rb
+- lib/relaton_xsf/hit_collection.rb
+- lib/relaton_xsf/processor.rb
+- lib/relaton_xsf/version.rb
+- lib/relaton_xsf/xml_parser.rb
+- sig/relaton_xsf.rbs
+homepage: https://github.com/relaton/relaton-xsf
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/relaton/relaton-xsf
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: 'RelatonIso: retrieve ISO Standards for bibliographic use using the IsoBibliographicItem
+  model'
+test_files: []