relaton-doi 0.1.pre1 → 1.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d7543dff584536fb709c5a291fbdc7e5620167a065aed24acb42913e32d17ae
-  data.tar.gz: 302928f0f388b4da0ac1b9b70f6d8b567c3467bd59a17385486608fd66f74bc4
+  metadata.gz: 53cd51733991e0f69cc3d0323cd9dff42122523c3a8f2d8e2738b1408da5321b
+  data.tar.gz: 7de2c0a2b3fa4369a832eaf1d655349bfe1682d86fc833da07be0243fadb7602
 SHA512:
-  metadata.gz: f80b7b5dcd73361411606b75ed1442db50934cf9a0fa2717ab1bc0b8dfcd7aefe0b06d135651cf060f16c3393ae6b705f053344530a177c4979ccff3eb5ac677
-  data.tar.gz: 6bbccb587b7457f064da5b9720722a85568be5421096ff149aac217eeaeb6d0255e1d25b7c7f7b1c82fb7d54ed2ae83ee6ca5a538b7bb453f703d3ce5003749c
+  metadata.gz: 4981dfeb396011af9fa1773f565009306664828231709d0e9d8ffa939f8e6f170dd09b4fe0793a5abbbcea07d024444737359a21e4e433c1b191f97fa245fc24
+  data.tar.gz: d599da84e5f7a0468decc094d449e7223dd63b5ff4a615993f34c882f43572fa9bb2287411228de21fc60c37c8c1b3572ae207b142335d4f618c6f8ad0d748c8

data/.github/workflows/rake.yml

@@ -5,32 +5,8 @@ name: rake
 on:
   push:
     branches: [ master, main ]
-    tags: [ v* ]
   pull_request:
 
 jobs:
   rake:
-    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        experimental: [ false ]
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-
-      # https://github.com/ruby-debug/debase/issues/89#issuecomment-686827382
-      - if: matrix.os == 'macos-latest' && matrix.ruby == '2.5'
-        run: echo BUNDLE_BUILD__DEBASE="--with-cflags=\"-Wno-error=implicit-function-declaration\"" >> $GITHUB_ENV
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - run: bundle exec rake
+    uses: relaton/support/.github/workflows/rake.yml@master

data/.github/workflows/release.yml

@@ -0,0 +1,22 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+        required: true
+        default: 'skip'
+  push:
+    tags: [ v* ]
+
+jobs:
+  release:
+    uses: relaton/support/.github/workflows/release.yml@master
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.RELATON_CI_RUBYGEMS_API_KEY }}

data/README.adoc

@@ -1,4 +1,4 @@
-= RelatonDoi retrieve Standards for bibliographic use using the BibliographicItem model
+= Relaton-DOI: retrieve 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,9 +8,11 @@ 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 https://github.com/metanorma/metanorma-model-iso#iso-bibliographic-item[IsoBibliographicItem model].
+RelatonDoi 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 access such metadata through the `BibliographicItem` object.
+You can use it to retrieve metadata of Standards from https://crossref.org, and
+access such metadata through the `BibliographicItem` object.
 
 == Installation
 
@@ -23,15 +25,25 @@ gem 'relaton-doi'
 
 And then execute:
 
-    $ bundle install
+[source,sh]
+----
+$ bundle install
+----
 
 Or install it yourself as:
 
-    $ gem install relaton-doi
+[source,ruby]
+----
+$ gem install relaton-doi
+----
 
 == Usage
 
-=== Search for a standard using DOI
+=== Retrieving items of known type using DOI
+
+If the resulting bibliographic item returned from CrossRef is a known Relaton
+flavor, such as a NIST or IEEE standard, the corresponding Relaton class object
+will be returned via the call.
 
 [source,ruby]
 ----
@@ -39,45 +51,66 @@ require 'relaton_doi'
 => true
 
 # get NIST standard
-RelatonDoi::Crossref.get "10.6028/nist.ir.8245"
-[relaton-doi] ["10.6028/nist.ir.8245"] fetching...
-[relaton-doi] ["10.6028/nist.ir.8245"] found 10.6028/nist.ir.8245
-=> #<RelatonNist::NistBibliographicItem:0x00007f9c813b6a58
+RelatonDoi::Crossref.get "doi:10.6028/nist.ir.8245"
+[relaton-doi] ["doi:10.6028/nist.ir.8245"] fetching...
+[relaton-doi] ["doi:10.6028/nist.ir.8245"] found 10.6028/nist.ir.8245
+=> #<RelatonNist::NistBibliographicItem:0x00007ff22420d820
 ...
 
 # get RFC standard
-RelatonDoi::Crossref.get "10.17487/RFC0001"
-[relaton-doi] ["10.17487/RFC0001"] fetching...
-[relaton-doi] ["10.17487/RFC0001"] found 10.17487/rfc0001
+RelatonDoi::Crossref.get "doi:10.17487/RFC0001"
+[relaton-doi] ["doi:10.17487/RFC0001"] fetching...
+[relaton-doi] ["doi:10.17487/RFC0001"] found 10.17487/rfc0001
 [relaton-ietf] WARNING: invalid doctype report
-=> #<RelatonIetf::IetfBibliographicItem:0x00007f9c8143d058
+=> #<RelatonIetf::IetfBibliographicItem:0x00007ff2241be6d0
 ...
 
 # get BIPM standard
-RelatonDoi::Crossref.get "10.1088/0026-1394/29/6/001"
-[relaton-doi] ["10.1088/0026-1394/29/6/001"] fetching...
-[relaton-doi] ["10.1088/0026-1394/29/6/001"] found 10.1088/0026-1394/29/6/001
+RelatonDoi::Crossref.get "doi:10.1088/0026-1394/29/6/001"
+[relaton-doi] ["doi:10.1088/0026-1394/29/6/001"] fetching...
+[relaton-doi] ["doi:10.1088/0026-1394/29/6/001"] found 10.1088/0026-1394/29/6/001
 => #<RelatonBipm::BipmBibliographicItem:0x00007f9c846f0a68
 ...
 
 # get IEEE standard
-RelatonDoi::Crossref.get "10.1109/ieeestd.2014.6835311"
-[relaton-doi] ["10.1109/ieeestd.2014.6835311"] fetching...
-[relaton-doi] ["10.1109/ieeestd.2014.6835311"] found 10.1109/ieeestd.2014.6835311
+RelatonDoi::Crossref.get "doi:10.1109/ieeestd.2014.6835311"
+[relaton-doi] ["doi:10.1109/ieeestd.2014.6835311"] fetching...
+[relaton-doi] ["doi:10.1109/ieeestd.2014.6835311"] found 10.1109/ieeestd.2014.6835311
 => #<RelatonIeee::IeeeBibliographicItem:0x00007f9cb46db688
 ...
 ----
 
+=== Retrieving items of unknown types via DOI
+
+If the resulting bibliographic item returned from CrossRef is of an unknown type
+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...
+[relaton-doi] ["doi:10.1109/ACCESS.2017.2739804"] found 10.1109/access.2017.2739804
+=> #<RelatonBib::BibliographicItem:0x00007ff22435e490
+...
+----
+
+
 == 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.
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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 the created tag, 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/[USERNAME]/relaton-doi.
+Bug reports and pull requests are welcome on GitHub at https://github.com/relaton/relaton-doi.
 
 == License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the https://opensource.org/licenses/MIT[MIT License].

data/lib/relaton_doi/crossref.rb

@@ -1,5 +1,33 @@
 module RelatonDoi
   class Crossref
+    TYPES = {
+      "book-chapter" => "inbook",
+      "book-part" => "inbook",
+      "book-section" => "inbook",
+      "book-series" => "book",
+      "book-set" => "book",
+      "book-track" => "inbook",
+      "component" => "misc",
+      "database" => "dataset",
+      "dissertation" => "thesis",
+      "edited-book" => "book",
+      "grant" => "misc",
+      "journal-article" => "article",
+      "journal-issue" => "journal",
+      "journal-volume" => "journal",
+      "monograph" => "book",
+      "other" => "misc",
+      "peer-review" => "article",
+      "posted-content" => "social_media",
+      "proceedings-article" => "inproceedings",
+      "proceedings-series" => "proceedings",
+      "reference-book" => "book",
+      "reference-entry" => "inbook",
+      "report-component" => "techreport",
+      "report-series" => "techreport",
+      "report" => "techreport",
+    }.freeze
+
     REALATION_TYPES = {
       "is-preprint-of" => "reprintOf",
       "is-review-of" => "reviewOf",
@@ -32,7 +60,8 @@ module RelatonDoi
     #
     def get(doi)
       warn "[relaton-doi] [\"#{doi}\"] fetching..."
-      resp = Serrano.works ids: doi
+      id = doi.sub(%r{^doi:}, "")
+      resp = Serrano.works ids: id
       @message = resp[0]["message"]
       warn "[relaton-doi] [\"#{doi}\"] found #{@message['DOI']}"
       create_bibitem @message["DOI"], bibitem_hash
@@ -70,7 +99,7 @@ module RelatonDoi
     #
     def bibitem_hash # rubocop:disable Metrics/MethodLength
       {
-        type: "standard",
+        type: parse_type,
         fetched: Date.today.to_s,
         title: create_title,
         docid: create_docid,
@@ -81,9 +110,19 @@ module RelatonDoi
         doctype: @message["type"],
         place: create_place,
         relation: create_relation,
+        extent: create_extent,
       }
     end
 
+    #
+    # Parse the document type.
+    #
+    # @return [String] The document type.
+    #
+    def parse_type
+      TYPES[@message["type"]] || @message["type"]
+    end
+
     #
     # Create a title and a subtitle from the message hash.
     #
@@ -136,9 +175,17 @@ module RelatonDoi
     # @return [Array<RelatonBib::TypedUri>] The link.
     #
     def create_link
-      return [] unless @message["URL"]
+      links = []
+      if @message["URL"]
+        links << RelatonBib::TypedUri.new(type: "DOI", content: @message["URL"])
+      end
+      return links unless @message["link"]&.any?
 
-      [RelatonBib::TypedUri.new(type: "DOI", content: @message["URL"])]
+      link = @message["link"].first
+      if link["URL"].match?(/\.pdf$/)
+        links << RelatonBib::TypedUri.new(type: "pdf", content: link["URL"])
+      end
+      links
     end
 
     #
@@ -161,15 +208,33 @@ module RelatonDoi
     #
     # @return [Array<RelatonBib::ContributionInfo>] The contributors.
     #
-    def create_contributors
+    def create_contributors # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
       contribs = %w[author editor translator].each_with_object([]) do |type, obj|
         @message[type]&.each do |contrib|
           obj << contributor(person(contrib), type)
         end
       end
+      contribs += fetch_editors if contribs.none? { |e| e.role.any? { |r| r.type == "editor" } }
       contribs << contributor(org_publisher, "publisher")
     end
 
+    #
+    # Fetch editors from Crossref.
+    #
+    # @return [Array<RelatonBib::ContributionInfo>] The editors.
+    #
+    def fetch_editors # rubocop:disable Metrics/AbcSize
+      title = @message["container-title"].first
+      year = (@message["published"] || @message["approved"])["date-parts"][0][0]
+      query = "#{title}, #{@message['publisher']}, #{@message['publisher-location']}, #{year}"
+      resp = Faraday.get %{http://api.crossref.org/works?query.bibliographic="#{query}"&rows=5&filter=type:book}
+      json = JSON.parse resp.body
+      item = json["message"]["items"].detect { |i| i["title"].include?(title) && i["editor"] }
+      return [] unless item
+
+      item["editor"].map { |a| contributor(person(a), "editor") }
+    end
+
     #
     # Cerate an organization publisher from the message hash.
     #
@@ -275,7 +340,7 @@ module RelatonDoi
     def forename(person)
       return [] unless person["given"]
 
-      [RelatonBib::LocalizedString.new(person["given"], "en", "Latn")]
+      [RelatonBib::Forename.new(content: person["given"], language: "en", script: "Latn")]
     end
 
     #
@@ -312,8 +377,9 @@ module RelatonDoi
     def create_place
       return [] unless @message["publisher-location"]
 
-      name, region = @message["publisher-location"].split(", ")
-      [RelatonBib::Place.new(name: name, region: region)]
+      city, rg = @message["publisher-location"].split(", ")
+      region = RelatonBib::Place::RegionType.new(name: rg)
+      [RelatonBib::Place.new(city: city, region: [region])]
     end
 
     #
@@ -321,13 +387,30 @@ module RelatonDoi
     #
     # @return [Array<RelatonBib::DocumentRelation>] The relations.
     #
-    def create_relation
-      @message["relation"].map do |k, v|
+    def create_relation # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      rels = []
+      @message["container-title"]&.each do |ct|
+        bib = RelatonBib::BibliographicItem.new(title: [content: ct])
+        rels << RelatonBib::DocumentRelation.new(type: "includedIn", bibitem: bib)
+      end
+      @message["relation"].each_with_object(rels) do |(k, v), a|
         fref = RelatonBib::FormattedRef.new(content: v["id"])
         bib = create_bibitem v["id"], formattedref: fref
         type = REALATION_TYPES[k] || k
-        RelatonBib::DocumentRelation.new(type: type, bibitem: bib)
+        a << RelatonBib::DocumentRelation.new(type: type, bibitem: bib)
       end
     end
+
+    #
+    # Create an extent from the message hash.
+    #
+    # @return [Array<RelatonBib::Locality>] The extent.
+    #
+    def create_extent
+      return [] unless @message["page"]
+
+      from, to = @message["page"].split("-")
+      [RelatonBib::Locality.new("page", from, to)]
+    end
   end
 end

data/lib/relaton_doi/processor.rb

@@ -0,0 +1,51 @@
+require "relaton/processor"
+
+module RelatonDoi
+  class Processor < Relaton::Processor
+    attr_reader :idtype
+
+    def initialize
+      @short = :relaton_doi
+      @prefix = "DOI"
+      @defaultprefix = %r{^doi:}
+      @idtype = "DOI"
+      # @datasets = %w[bipm-data-outcomes bipm-si-brochure]
+    end
+
+    # @param code [String] DOI
+    # @param date [String, nil] year
+    # @param opts [Hash]
+    # @return [RelatonBib::BibliographicItem]
+    def get(code, _date, _opts)
+      Crossref.get(code)
+    end
+
+    #
+    # @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)
+    #   DataFetcher.fetch(source, **opts)
+    # end
+
+    # @param xml [String]
+    # @return [RelatonBipm::BipmBibliographicItem]
+    def from_xml(xml)
+      ::RelatonBib::XMLParser.from_xml xml
+    end
+
+    # @param hash [Hash]
+    # @return [RelatonBipm::BipmBibliographicItem]
+    def hash_to_bib(hash)
+      ::RelatonBib::BibliographicItem.from_hash hash
+    end
+
+    # Returns hash of XML grammar
+    # @return [String]
+    def grammar_hash
+      @grammar_hash ||= ::RelatonBib.grammar_hash
+    end
+  end
+end

data/lib/relaton_doi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RelatonDoi
-  VERSION = "0.1.pre1"
+  VERSION = "1.14.1"
 end

data/relaton-doi.gemspec

@@ -41,11 +41,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 
-  spec.add_dependency "relaton-bipm", "~> 1.10.0"
-  spec.add_dependency "relaton-ieee", "~> 1.10.0"
-  spec.add_dependency "relaton-ietf", "~> 1.10.0"
-  # spec.add_dependency "relaton-iso-bib", "~> 1.10.0"
-  spec.add_dependency "relaton-nist", "~> 1.10.0"
+  spec.add_dependency "relaton-bib", "~> 1.14.1"
+  spec.add_dependency "relaton-bipm", "~> 1.14.0"
+  spec.add_dependency "relaton-ieee", "~> 1.14.0"
+  spec.add_dependency "relaton-ietf", "~> 1.14.0"
+  spec.add_dependency "relaton-nist", "~> 1.14.0"
   # spec.add_dependency "relaton-w3c", "~> 1.10.0"
   spec.add_dependency "serrano", "~> 1.0.0"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-doi
 version: !ruby/object:Gem::Version
-  version: 0.1.pre1
+  version: 1.14.1
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2022-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
@@ -94,62 +94,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: relaton-bib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.1
 - !ruby/object:Gem::Dependency
   name: relaton-bipm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.14.0
 - !ruby/object:Gem::Dependency
   name: relaton-ieee
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.14.0
 - !ruby/object:Gem::Dependency
   name: relaton-ietf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.14.0
 - !ruby/object:Gem::Dependency
   name: relaton-nist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.14.0
 - !ruby/object:Gem::Dependency
   name: serrano
   requirement: !ruby/object:Gem::Requirement
@@ -173,6 +187,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/rake.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -185,6 +200,7 @@ files:
 - bin/setup
 - lib/relaton_doi.rb
 - lib/relaton_doi/crossref.rb
+- lib/relaton_doi/processor.rb
 - lib/relaton_doi/version.rb
 - relaton-doi.gemspec
 homepage: https://github.com/relaton/relaton-doi
@@ -192,7 +208,7 @@ licenses:
 - BSD-2-Clause
 metadata:
   homepage_uri: https://github.com/relaton/relaton-doi
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -203,12 +219,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: 'RelatonDOI: retrieve Standards for bibliographic using DOI through Crossrefand
   provide Relaton object.'