relaton-etsi 1.20.2 → 2.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9db12fcd09fa10052380fe87eac90777880e224594c4f47487b6010283cf5d82
-  data.tar.gz: b33c26ffb892562a8a46eb07f2e10cfe50d83585596f6331baa93f360894f6c5
+  metadata.gz: af47d7cc7e2e22171fad2500c4b5018c06afa0efe05a3a613980a9d7eee72257
+  data.tar.gz: e48dc2964425154e9bedff060231c66d490435a450b1ddc1216fe2d1ec7db893
 SHA512:
-  metadata.gz: 227db6b7da0fd223ad0f272fbf4c7da06dcbe587dc973cafd32af8d3de9a09ef0d2600f427a14f56945dac93fb5f65d486c02b7ba61ad09e659f8d36b9b49b4a
-  data.tar.gz: ebeec237a1f36122db9d6178201ab44b2dcc347cd0141e3b12e418d35b45f7eb31999dbf1710b911ef041964b0aeded269ff4231f17bf490292598211d3f7949
+  metadata.gz: 125bdcdc240940e0717bb633c200af84b978c6d700e887505fd7a285ec917a18793ac0506de389ccda329f685e9d2871431ccf1cc2ed8c77ddfa0c1e7b952d57
+  data.tar.gz: 901a093a9f9e7b443fb3e6270c6f1eb4fa8bcea76a4e7deea14889c4d013b94e08f16c6789a68bae32960e8be7cab3fe8885c8474528c02b78772a32d508b729

data/.rubocop.yml

@@ -7,6 +7,6 @@ require: rubocop-rails
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.2
 Rails:
   Enabled: false

data/CLAUDE.md

@@ -2,66 +2,68 @@
 
 This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
 
-## Build and Test Commands
+## Project Overview
+
+relaton-etsi is a Ruby gem that retrieves ETSI (European Telecommunications Standards Institute) standards metadata using the Relaton bibliographic item model. It fetches data from the ETSI website and the relaton-data-etsi GitHub repository.
+
+## Commands
 
 ```bash
 # Install dependencies
 bin/setup
 
 # Run all tests
-bundle exec rake spec
+rake spec
 
-# Run a single test file
-bundle exec rspec spec/relaton_etsi/bibliography_spec.rb
+# Run a specific test file
+rspec spec/relaton/etsi/bibliography_spec.rb
 
-# Run a single test by line number
-bundle exec rspec spec/relaton_etsi/bibliography_spec.rb:15
+# Run a specific test by line number
+rspec spec/relaton/etsi/bibliography_spec.rb:15
 
 # Run linter
-bundle exec rubocop
+rake rubocop
 
-# Run linter with auto-fix
-bundle exec rubocop -a
-
-# Interactive console for experimentation
+# Interactive console
 bin/console
+
+# Install gem locally
+bundle exec rake install
 ```
 
 ## Architecture
 
-This gem is part of the [Relaton](https://github.com/relaton) ecosystem for retrieving and managing bibliographic data from standards organizations. It specifically handles ETSI (European Telecommunications Standards Institute) standards.
+The codebase is transitioning from `RelatonEtsi` namespace to `Relaton::Etsi` namespace.
 
-### Core Dependencies
-- `relaton-bib` - Base bibliographic classes that this gem extends
-- `relaton-index` - Document indexing for search functionality
+### New Architecture (lib/relaton/etsi/)
 
-### Key Classes
+Uses Lutaml for serialization:
+- `Item` - base bibliographic item inheriting from `Bib::Item`
+- `Bibitem` - for `<bibitem>` XML output (includes `Bib::BibitemShared`)
+- `Bibdata` - for `<bibdata>` XML output (includes `Bib::BibdataShared`)
+- `Ext` - ETSI-specific extension data (marker, frequency, mandate, custom_collection)
+- `Doctype` - ETSI document type with abbreviations (EN, ES, GS, TS, TR, etc.)
 
-**Entry Points:**
-- `Bibliography` - Main API: `RelatonEtsi::Bibliography.get("ETSI GS ZSM 012 V1.1.1")` searches the Relaton index and returns a `BibliographicItem`
-- `Processor` - Relaton integration point, registered with the main relaton gem
+### Legacy Architecture (lib/relaton_etsi/)
 
-**Data Model:**
-- `BibliographicItem` extends `RelatonBib::BibliographicItem` with ETSI-specific fields: `marker`, `frequency`, `mandate`, `custom_collection`
-- `DocumentType` - ETSI document type abbreviations (EN, ES, EG, TS, GS, GR, TR, etc.) and their full names
-- `PubId` - Parser for ETSI document identifiers, extracting type, docnumber, version, edition, and date
+- `BibliographicItem` - extends `RelatonBib::BibliographicItem`
+- `XMLParser` - parses XML into bibliographic items
+- `HashConverter` - converts hashes to bibliographic items
+- `DocumentType` - document type with type/abbreviation mapping
 
-**Data Fetching:**
-- `DataFetcher` - Bulk fetches all documents from www.etsi.org CSV export
-- `DataParser` - Transforms CSV rows into `BibliographicItem` objects
+### Core Components
 
-**Serialization:**
-- `XMLParser` extends `RelatonBib::XMLParser` for ETSI-specific XML parsing
-- `HashConverter` includes `RelatonBib::HashConverter` for YAML/Hash conversion
+- `Bibliography` - searches and retrieves standards from relaton-data-etsi index
+- `DataFetcher` - fetches all documents from ETSI website CSV export
+- `DataParser` - parses CSV rows into bibliographic items
+- `Processor` - Relaton processor for integration with the relaton ecosystem
 
 ### Data Flow
-1. `Bibliography.search` queries the GitHub-hosted index (`relaton-data-etsi`)
-2. Matching documents are fetched as YAML from the data repository
-3. `HashConverter` transforms YAML to constructor arguments
-4. `BibliographicItem` is instantiated and returned
 
-For bulk data generation, `DataFetcher` downloads CSV from etsi.org, parses each row with `DataParser`, and saves to files.
+1. `Bibliography.get(ref)` searches the relaton-data-etsi index
+2. Fetches YAML from GitHub, converts to `Item` using `from_yaml`
+3. `DataFetcher.fetch` pulls CSV from etsi.org, parses with `DataParser`, saves to output folder
 
 ## Testing
 
-Tests use VCR cassettes in `spec/vcr_cassettes/` to record/replay HTTP interactions. When updating tests that make HTTP calls, delete the relevant cassette to re-record.
+Uses RSpec with VCR for HTTP interaction recording. VCR cassettes are in `spec/vcr_cassettes/`. When tests make new HTTP requests, VCR will record them.

data/README.adoc

@@ -1,8 +1,8 @@
-= RelatonEtsi
+= Relaton::Etsi
 
-RelatonEtsi is a Ruby gem that implements the https://github.com/relaton/relaton-models#bibliographic-item[BibliographicItem model].
+Relaton::Etsi 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.
+You can use it to retrieve metadata of ETSI Standards and access such metadata through the `Relaton::Etsi::Item` object.
 
 == Installation
 
@@ -27,13 +27,13 @@ Or install it yourself as:
 
 [source,ruby]
 ----
-require 'relaton_etsi'
+require "relaton/etsi"
 => true
 
-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
+item = Relaton::Etsi::Bibliography.get("ETSI GS ZSM 012 V1.1.1")
+[relaton-etsi] INFO: (ETSI GS ZSM 012 V1.1.1) Fetching from Relaton repository ...
+[relaton-etsi] INFO: (ETSI GS ZSM 012 V1.1.1) Found: `ETSI GS ZSM 012 V1.1.1 (2022-12)`
+=> #<Relaton::Etsi::ItemData:0x0000000125869dd8
 ...
 ----
 
@@ -42,9 +42,9 @@ item = RelatonEtsi::Bibliography.get("ETSI GS ZSM 012 V1.1.1")
 [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>
+=> "<bibitem id="ETSIGSZSM012V111202212" schema-version="v1.4.1">
+      <fetched>2026-01-24</fetched>
+      <title 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>
@@ -55,74 +55,59 @@ With argument `bibdata: true` it outputs XML wrapped by `bibdata` element and ad
 [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>
+=> "<bibdata schema-version="v1.4.1">
+      <fetched>2026-01-24</fetched>
+      <title 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
+=== Typed source 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
+item.source
+=>
+[#<Relaton::Bib::Uri:0x0000000129ea7b38 @content="http://webapp.etsi.org/workprogram/Report_WorkItem.asp?WKI_ID=62010", @language=nil, @locale=nil, @script=nil, @type="src">,
+ #<Relaton::Bib::Uri:0x0000000129ea76d8 @content="http://www.etsi.org/deliver/etsi_gs/ZSM/001_099/012/01.01.01_60/gs_ZSM012v010101p.pdf", @language=nil, @locale=nil, @script=nil, @type="pdf">]
+
+item.source.size
 => 2
 
-item.link[0].type
+item.source[0].type
 => "src"
 
-item.link[0].content.to_s
+item.source[0].content
 => "http://webapp.etsi.org/workprogram/Report_WorkItem.asp?WKI_ID=62010"
 
-item.link[1].type
+item.source[1].type
 => "pdf"
 
-item.link[1].content.to_s
+item.source[1].content
 => "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
+Relaton::Etsi::Item.from_xml File.read('spec/fixtures/bibdata.xml')
+=> #<Relaton::Etsi::ItemData:0x000000012b68f660
 ...
 ----
 
 === 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
+Relaton::Etsi::Item.from_yaml File.read('spec/fixtures/item.yaml')
+=> #<Relaton::Etsi::ItemData:0x0000000126e34c58
 ...
 ----
 
@@ -130,7 +115,7 @@ RelatonEtsi::BibliographicItem.from_hash hash
 
 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.
+The method `Relaton::Etsi::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').
@@ -138,7 +123,10 @@ Arguments:
 
 [source,ruby]
 ----
-RelatonEtsi::DataFetcher.fetch
+require 'relaton/etsi/data_fetcher'
+=> true
+
+Relaton::Etsi::DataFetcher.fetch
 Started at: 2023-12-05 22:44:32 -0500
 Stopped at: 2023-12-05 22:47:55 -0500
 Done in: 204 sec.
@@ -147,7 +135,7 @@ Done in: 204 sec.
 
 === Logging
 
-RelatonEtsi uses the relaton-logger gem for logging. By default, it logs to STDOUT. To change the log levels and add other loggers, read the https://github.com/relaton/relaton-logger#usage[relaton-logger] documentation.
+Relaton::Etsi uses the relaton-logger gem for logging. By default, it logs to STDOUT. To change the log levels and add other loggers, read the https://github.com/relaton/relaton-logger#usage[relaton-logger] documentation.
 
 == Development