relaton-doi 1.20.1 → 2.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c4c9621e29ce8c9e21c5a87dc09a40ee02dbbda06339c629eb89dafc4ad198b
-  data.tar.gz: 220d1d32f0cf84917922683c5f6e6eeea6731d2d01e668e2336116d82c4f62ea
+  metadata.gz: 0f7e17ade3de5350425a977bc98d1138372e8bc488b1d2167f01faf9005ef25a
+  data.tar.gz: 6073344cefc01c1d6c4927e6e8d1244479e78412fe2a6161aadf5eedb150f7a6
 SHA512:
-  metadata.gz: 625c124cd3d8711cd8fdb1e9eeb546ef76686a5b5abd4988545590e201127b24e162f5c1e5279c204ada49abd8cf865da013ecab18032d061810a9c8ff093bf4
-  data.tar.gz: 8e3e98bdd1d71630252a59e4ce033ea3f8f3572ec01d312a3cfb772a79c101dd44410b1182d8055399ce8442895bf22c152c78ee5ba68765dfcd9a397fcf254e
+  metadata.gz: 828e003d8e8aee68503d099d3935cebc5c8d5efcd7fb6662734dec73e95f6b4c21011dbee3822130169c914bcdefa6a4be167d8b9d00b15fe75c21ead14530c7
+  data.tar.gz: 5c36820805071f3b77af5158ed542aaab498ba03724df8f912e6cc75ec4f8a7d9406124cc2fd26dacf03dfb5fc0d9c2f9f1fb27c7e685863a49965d64fb92496

data/.gitignore

@@ -13,3 +13,4 @@
 Gemfile.lock
 .vscode/
 .rubocop-remote-87c7cdd254a8d09d005ee06efac7acc0.yml
+.claude/

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

@@ -0,0 +1,45 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project
+
+relaton-doi is a Ruby gem that fetches bibliographic metadata via DOI identifiers from the Crossref API and converts them into Relaton bibliographic objects. It detects DOI patterns to produce flavor-specific items (NIST, IETF, BIPM, IEEE) or generic `Bib::ItemData`.
+
+## Common Commands
+
+```bash
+bundle exec rake spec          # Run all tests (default rake task)
+bundle exec rspec spec/relaton/doi/parser_spec.rb  # Run a single spec file
+bundle exec rspec spec/relaton/doi/parser_spec.rb:224  # Run a single example by line
+rubocop                        # Lint
+rubocop -a                     # Lint with auto-correct
+```
+
+## Architecture
+
+**Namespace:** `Relaton::Doi` (migrated from legacy `RelatonDoi`).
+
+**Core flow:** `Crossref.get(doi)` → HTTP fetch from api.crossref.org → `Parser.parse(json_hash)` → flavor-specific `ItemData`
+
+Key classes in `lib/relaton/doi/`:
+
+- **`Crossref`** — module with `get(doi)` and `get_by_id(id)`. Uses Faraday with retry logic (3 retries). Handles rate limiting via `x-rate-limit-interval` header.
+- **`Parser`** — largest file (~827 lines). Converts Crossref JSON hashes to Relaton objects. Factory method `parse(src)` delegates to `create_bibitem` which picks the right ItemData class based on DOI pattern (`/nist/` → `Nist::ItemData`, `/rfc\d+/` → `Ietf::ItemData`, etc.). Contains ~30 `parse_*` helper methods for individual bibliographic fields.
+- **`Processor`** — `Relaton::Processor` subclass for the Relaton registry system. Entry point for `get`, `from_xml`, `hash_to_bib`.
+- **`Util`** — logging utility, extends `Relaton::Bib::Util` with `PROGNAME = "relaton-doi"`.
+
+## Test Setup
+
+- **RSpec** with `expect` syntax only (monkey patching disabled)
+- **VCR** cassettes in `spec/vcr_cassettes/` record Crossref HTTP responses (re-recorded every 7 days)
+- **XML fixtures** in `spec/fixtures/` — expected output XML files. The `read_fixture` helper auto-substitutes today's date into `<fetched>` tags.
+- **equivalent-xml** gem for XML comparison in integration tests
+- Integration tests in `spec/relaton/doi_spec.rb` cover 40+ document types via VCR cassettes
+- Unit tests in `spec/relaton/doi/parser_spec.rb` test Parser methods directly with hash inputs
+
+## Key Constants in Parser
+
+- `TYPES` — maps 23 Crossref document types to Relaton types (e.g., `"book-chapter"` → `"inbook"`)
+- `REALATION_TYPES` — maps 37 Crossref relation types to Relaton relation types
+- `COUNTRIES` — `%w[USA]`, used by `parse_place` to distinguish country vs region

data/README.adoc

@@ -1,4 +1,4 @@
-= Relaton-DOI: retrieve bibliographic items using DOI
+= Relaton::Doi retrieves bibliographic items using DOI
 
 image:https://img.shields.io/gem/v/relaton-doi.svg["Gem Version", link="https://rubygems.org/gems/relaton-doi"]
 image:https://github.com/relaton/relaton-doi/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/relaton/relaton-doi/actions?workflow=macos"]
@@ -8,7 +8,7 @@ image:https://codeclimate.com/github/relaton/relaton-doi/badges/gpa.svg["Code Cl
 image:https://img.shields.io/github/issues-pr-raw/relaton/relaton-doi.svg["Pull Requests", link="https://github.com/relaton/relaton-doi/pulls"]
 image:https://img.shields.io/github/commits-since/relaton/relaton-doi/latest.svg["Commits since latest",link="https://github.com/relaton/relaton-doi/releases"]
 
-RelatonDoi is a Ruby gem that implements the
+Relaton::Doi is a Ruby gem that implements the
 https://github.com/metanorma/metanorma-model-iso#iso-bibliographic-item[IsoBibliographicItem model].
 
 You can use it to retrieve metadata of Standards from https://crossref.org, and
@@ -49,36 +49,35 @@ will be returned via the call.
 
 [source,ruby]
 ----
-require 'relaton_doi'
+require 'relaton/doi'
 => true
 
 # get NIST standard
-RelatonDoi::Crossref.get "doi:10.6028/nist.ir.8245"
-[relaton-doi] (doi:10.6028/nist.ir.8245) Fetching from search.crossref.org ...
-[relaton-doi] (doi:10.6028/nist.ir.8245) Found: `10.6028/nist.ir.8245`
-=> #<RelatonNist::NistBibliographicItem:0x00007ff22420d820
+Relaton::Doi::Crossref.get "doi:10.6028/nist.ir.8245"
+[relaton-doi] INFO: (doi:10.6028/nist.ir.8245) Fetching from search.crossref.org ...
+[relaton-doi] INFO: (doi:10.6028/nist.ir.8245) Found: `10.6028/nist.ir.8245`
+=> #<Relaton::Nist::ItemData:0x000000011040a338
 ...
 
 # get RFC standard
-RelatonDoi::Crossref.get "doi:10.17487/RFC0001"
-[relaton-doi] (doi:10.17487/RFC0001) Fetching from search.crossref.org ...
-[relaton-doi] (doi:10.17487/RFC0001) Found: `10.17487/rfc0001`
-[relaton-ietf] WARNING: Invalid doctype report
-=> #<RelatonIetf::IetfBibliographicItem:0x00007ff2241be6d0
+Relaton::Doi::Crossref.get "doi:10.17487/RFC0001"
+[relaton-doi] INFO: (doi:10.17487/RFC0001) Fetching from search.crossref.org ...
+[relaton-doi] INFO: (doi:10.17487/RFC0001) Found: `10.17487/rfc0001`
+=> #<Relaton::Ietf::ItemData:0x0000000110be8410
 ...
 
 # get BIPM standard
-RelatonDoi::Crossref.get "doi:10.1088/0026-1394/29/6/001"
-[relaton-doi] (doi:10.1088/0026-1394/29/6/001) Fetching from search.crossref.org ...
-[relaton-doi] (doi:10.1088/0026-1394/29/6/001) Found: `10.1088/0026-1394/29/6/001`
-=> #<RelatonBipm::BipmBibliographicItem:0x00007f9c846f0a68
+Relaton::Doi::Crossref.get "doi:10.1088/0026-1394/29/6/001"
+[relaton-doi] INFO: (doi:10.1088/0026-1394/29/6/001) Fetching from search.crossref.org ...
+[relaton-doi] INFO: (doi:10.1088/0026-1394/29/6/001) Found: `10.1088/0026-1394/29/6/001`
+=> #<Relaton::Bipm::ItemData:0x00000001118dcbf8
 ...
 
 # get IEEE standard
-RelatonDoi::Crossref.get "doi:10.1109/ieeestd.2014.6835311"
-[relaton-doi] (doi:10.1109/ieeestd.2014.6835311) Fetching from search.crossref.org ...
-[relaton-doi] (doi:10.1109/ieeestd.2014.6835311) Found: `10.1109/ieeestd.2014.6835311`
-=> #<RelatonIeee::IeeeBibliographicItem:0x00007f9cb46db688
+Relaton::Doi::Crossref.get "doi:10.1109/ieeestd.2014.6835311"
+[relaton-doi] INFO: (doi:10.1109/ieeestd.2014.6835311) Fetching from search.crossref.org ...
+[relaton-doi] INFO: (doi:10.1109/ieeestd.2014.6835311) Found: `10.1109/ieeestd.2014.6835311`
+=> #<Relaton::Ieee::ItemData:0x0000000110ec5c00
 ...
 ----
 
@@ -89,16 +88,16 @@ to Relaton, an instance of RelatonBib::BibliographicItem will be returned.
 
 [source,ruby]
 ----
-RelatonDoi::Crossref.get "doi:10.1109/ACCESS.2017.2739804"
-[relaton-doi] (doi:10.1109/ACCESS.2017.2739804) Fetching from search.crossref.org ...
-[relaton-doi] (doi:10.1109/ACCESS.2017.2739804) Found: `10.1109/access.2017.2739804`
-=> #<RelatonBib::BibliographicItem:0x00007ff22435e490
+Relaton::Doi::Crossref.get "doi:10.1109/ACCESS.2017.2739804"
+[relaton-doi] INFO: (doi:10.1109/ACCESS.2017.2739804) Fetching from search.crossref.org ...
+[relaton-doi] INFO: (doi:10.1109/ACCESS.2017.2739804) Found: `10.1109/access.2017.2739804`
+=> #<Relaton::Bib::ItemData:0x0000000110f0bde0
 ...
 ----
 
 === Logging
 
-RelatonDoi 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::Doi 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
 

data/lib/relaton/doi/crossref.rb

@@ -0,0 +1,64 @@
+require "faraday"
+
+module Relaton
+  module Doi
+    module Crossref
+      extend self
+
+      HEADER = {
+        "User-Agent" => "Relaton::Doi (https://www.relaton.org/guides/doi/; mailto:open.source@ribose.com)"
+      }.freeze
+
+      #
+      # Get a document by DOI from the CrossRef API.
+      #
+      # @param [String] doi The DOI.
+      #
+      # @return [RelatonBib::BibliographicItem, RelatonIetf::IetfBibliographicItem,
+      #   RelatonBipm::BipmBibliographicItem, RelatonIeee::IeeeBibliographicItem,
+      #   RelatonNist::NistBibliographicItem] The bibitem.
+      #
+      def get(doi)
+        Util.info "Fetching from search.crossref.org ...", key: doi
+        id = doi.sub(%r{^doi:}, "")
+        message = get_by_id id
+        if message
+          Util.info "Found: `#{message['DOI']}`", key: doi
+          Parser.parse message
+        else
+          Util.info "Not found.", key: doi
+          nil
+        end
+      end
+
+      #
+      # Get a document by DOI from the CrossRef API.
+      #
+      # @param [String] id The DOI.
+      #
+      # @return [Hash] The document.
+      #
+      def get_by_id(id) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        # resp = Serrano.works ids: id
+        n = 0
+        url = "https://api.crossref.org/works/#{CGI.escape(id)}"
+        loop do
+          resp = Faraday.get url, nil, HEADER
+          case resp.status
+          when 200
+            work = JSON.parse resp.body
+            return work["message"] if work["status"] == "ok"
+          when 404 then return nil
+          end
+
+          if n > 1
+            raise Relaton::RequestError, "Crossref error: #{resp.body}"
+          end
+
+          n += 1
+          sleep resp.headers["x-rate-limit-interval"].to_i * n
+        end
+      end
+    end
+  end
+end