relaton-etsi 1.17.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6e4ba041c037da56897365348dd11adedc34ea8f92cef0f762995bb7613d8fe
+  data.tar.gz: ddf0f3bef8c7d2292ce6a9e34c6d0b70b04df1ad0c5c5d7f2497b81b686080e0
+SHA512:
+  metadata.gz: 238a85539e7e015d69242fb759a6d36c22186c664a15b8dc6d1069ed3583bec2517a42860da7f74005f0c68981c985bb1e2c9e6aa4ee419bfdcf0d1e4bbf6271
+  data.tar.gz: edfbe1047d23e749c92294ff2cf2b5365344a8873b38c05ed37d1b1af77b6e56e2b6bf1ec6b98e6e835bfde3c22f1bfb8170b23548570c308e1eced5235d6c25

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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Andrei Kislichenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,171 @@
+= RelatonEtsi
+
+RelatonEtsi is a Ruby gem that implements the https://github.com/relaton/relaton-models#bibliographic-item[BibliographicItem model].
+
+You can use it to retrieve metadata of ETSI Standards and access such metadata through the `RelatonEtsi::BibliographicItem` object.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'relaton-etsi'
+----
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install relaton-etsi
+
+== Usage
+
+=== Configuration
+
+Configuration is optional. The available option is `logger` which is a `Logger` instance. By default, the logger is `Logger.new($stderr)` with `Logger::WARN` level. To change the logger level, use `RelatonEtsi.configure` block.
+
+[source,ruby]
+----
+require 'relaton_etsi'
+=> true
+
+RelatonEtsi.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Search for a standard using keywords
+
+[source,ruby]
+----
+item = RelatonEtsi::Bibliography.get("ETSI GS ZSM 012 V1.1.1")
+[relaton-etsi] (ETSI GS ZSM 012 V1.1.1) Fetching from Relaton repository ...
+[relaton-etsi] (ETSI GS ZSM 012 V1.1.1) Found: `ETSI GS ZSM 012 V1.1.1 (2022-12)`
+=> #<RelatonEtsi::BibliographicItem:0x000000010686fa18
+...
+----
+
+=== XML serialization
+
+[source,ruby]
+----
+item.to_xml
+=> "<bibitem id="ETSIGSZSM012V1.1.12022-12" schema-version="v1.2.7">
+      <fetched>2023-12-05</fetched>
+      <title format="text/plain" language="en" script="Latn">Zero-touch network and Service Management (ZSM); Enablers for Artificial Intelligence-based Network and Service Automation</title>
+      <uri type="src">http://webapp.etsi.org/workprogram/Report_WorkItem.asp?WKI_ID=62010</uri>
+      <uri type="pdf">http://www.etsi.org/deliver/etsi_gs/ZSM/001_099/012/01.01.01_60/gs_ZSM012v010101p.pdf</uri>
+      <docidentifier type="ETSI" primary="true">ETSI GS ZSM 012 V1.1.1 (2022-12)</docidentifier>
+      ...
+    </bibitem>"
+----
+With argument `bibdata: true` it outputs XML wrapped by `bibdata` element and adds flavour `ext` element.
+[source,ruby]
+----
+item.to_xml bibdata: true
+=> "<bibdata schema-version="v1.2.7">
+      <fetched>2023-12-05</fetched>
+      <title format="text/plain" language="en" script="Latn">Zero-touch network and Service Management (ZSM); Enablers for Artificial Intelligence-based Network and Service Automation</title>
+      <uri type="src">http://webapp.etsi.org/workprogram/Report_WorkItem.asp?WKI_ID=62010</uri>
+      <uri type="pdf">http://www.etsi.org/deliver/etsi_gs/ZSM/001_099/012/01.01.01_60/gs_ZSM012v010101p.pdf</uri>
+      <docidentifier type="ETSI" primary="true">ETSI GS ZSM 012 V1.1.1 (2022-12)</docidentifier>
+      ...
+      <ext schema-version="v0.0.3">
+        <doctype abbreviation="GS">Group Specification</doctype>
+        <editorialgroup>
+          <technical-committee>Zero-touch network and Service Management</technical-committee>
+        </editorialgroup>
+      </ext>
+    </bibdata>"
+----
+
+=== Typed links
+
+All the ETSI documents have SRC and PDF links. The gem provides a way to access these links through the `RelatonBib::TypedUri` object.
+
+[source,ruby]
+----
+item.link
+=> [#<RelatonBib::TypedUri:0x00000001083da780
+  @content=#<Addressable::URI:0xb40 URI:http://webapp.etsi.org/workprogram/Report_WorkItem.asp?WKI_ID=62010>,
+  @language=nil,
+  @script=nil,
+  @type="src">,
+ #<RelatonBib::TypedUri:0x00000001083da690
+  @content=#<Addressable::URI:0xb54 URI:http://www.etsi.org/deliver/etsi_gs/ZSM/001_099/012/01.01.01_60/gs_ZSM012v010101p.pdf>,
+  @language=nil,
+  @script=nil,
+  @type="pdf">]
+
+item.link.size
+=> 2
+
+item.link[0].type
+=> "src"
+
+item.link[0].content.to_s
+=> "http://webapp.etsi.org/workprogram/Report_WorkItem.asp?WKI_ID=62010"
+
+item.link[1].type
+=> "pdf"
+
+item.link[1].content.to_s
+=> "http://www.etsi.org/deliver/etsi_gs/ZSM/001_099/012/01.01.01_60/gs_ZSM012v010101p.pdf"
+----
+
+=== Create bibliographic item from XML
+[source,ruby]
+----
+RelatonEtsi::XMLParser.from_xml File.read('spec/fixtures/bibdata.xml')
+=> #<RelatonEtsi::BibliographicItem:0x000000010a7644d0
+...
+----
+
+=== Create bibliographic item from YAML
+[source,ruby]
+----
+hash = YAML.load_file 'spec/fixtures/item_hash.yaml'
+=> {"schema-version"=>"v1.2.7",
+ "id"=>"ETSIEN319532-4V1.3.02023-10",
+...
+
+RelatonEtsi::BibliographicItem.from_hash hash
+=> #<RelatonEtsi::BibliographicItem:0x000000010a76cf90
+...
+----
+
+=== Fetch data
+
+This gem uses the https://www.etsi.org as a data source.
+
+The method `RelatonEtsi::DataFetcher.fetch(output: "data", format: "yaml")` fetches all the documents from the data source 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`, `bibxml` (default `yaml`).
+
+[source,ruby]
+----
+RelatonEtsi::DataFetcher.fetch
+Started at: 2023-12-05 22:44:32 -0500
+Stopped at: 2023-12-05 22:47:55 -0500
+Done in: 204 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 [rubygems.org](https://rubygems.org).
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/relaton/relaton-etsi.
+
+== License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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]