relaton-isbn 1.17.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67f72a126942d761c281807d95cfb1c4feefb68a00029f3d284cd19d77022288
+  data.tar.gz: fd31af74cfbaca0480129f4aa3f02e3cc4761022d2c3f2b8cb46c1278d46dd40
+SHA512:
+  metadata.gz: 5d199ef47b949e0fdeec3b6fa2d43fe93e136faef853e6ab1cfa45e26378f2b4bdd2e308813f31eec60a60714ded305e85f9d67105b5224e03b92a4072f3feac
+  data.tar.gz: 68b8bb3a2a2ea06f687a984145dedde9a782bcb9979e4286ba17bbcad4bc9a039942efa4b20313d98fe765d0c2cd73cff2e4b2fe6baffa1113ec345986c933aa

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,90 @@
+= Relaton-ISBN: retrieves bibliographic items using OpenLibrary API
+
+image:https://img.shields.io/gem/v/relaton-isbn.svg["Gem Version", link="https://rubygems.org/gems/relaton-isbn"]
+image:https://github.com/relaton/relaton-isbn/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/relaton/relaton-isbn/actions?workflow=macos"]
+image:https://github.com/relaton/relaton-isbn/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/relaton/relaton-isbn/actions?workflow=windows"]
+image:https://github.com/relaton/relaton-isbn/workflows/ubuntu/badge.svg["Build Status (Ubuntu)", link="https://github.com/relaton/relaton-isbn/actions?workflow=ubuntu"]
+image:https://codeclimate.com/github/relaton/relaton-isbn/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/relaton/relaton-isbn"]
+image:https://img.shields.io/github/issues-pr-raw/relaton/relaton-isbn.svg["Pull Requests", link="https://github.com/relaton/relaton-isbn/pulls"]
+image:https://img.shields.io/github/commits-since/relaton/relaton-isbn/latest.svg["Commits since latest",link="https://github.com/relaton/relaton-isbn/releases"]
+
+RelatonIsbn 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.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'relaton-isbn'
+----
+
+And then execute:
+
+[source,sh]
+----
+$ bundle install
+----
+
+Or install it yourself as:
+
+[source,sh]
+----
+$ gem install relaton-isbn
+----
+
+== 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 `RelatonIsbn.configure` block.
+
+[source,ruby]
+----
+require 'relaton_isbn'
+=> true
+
+RelatonIsbn.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Retrieving items of known type using OpenLibrary API
+
+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]
+----
+# get document by ISBN
+RelatonIsbn::OpenLibrary.get "ISBN 9780120644810"
+[relaton-isbn] (ISBN 9780120644810) Fetching from OpenLibrary ...
+[relaton-isbn] (ISBN 9780120644810) Found: `9780120644810`
+=> #<RelatonBib::BibliographicItem:0x0000000113889258
+...
+----
+
+== 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 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/relaton/relaton-isbn.
+
+== License
+
+The gem is available as open source under the terms of the https://opensource.org/licenses/MIT[MIT 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_isbn/config.rb

@@ -0,0 +1,10 @@
+module RelatonIsbn
+  module Config
+    include RelatonBib::Config
+  end
+  extend Config
+
+  class Configuration < RelatonBib::Configuration
+    PROGNAME = "relaton-isbn".freeze
+  end
+end

data/lib/relaton_isbn/open_library.rb

@@ -0,0 +1,38 @@
+module RelatonIsbn
+  #
+  # Search ISBN in Openlibrary.
+  #
+  module OpenLibrary
+    extend self
+
+    ENDPOINT = "http://openlibrary.org/api/volumes/brief/isbn/".freeze
+
+    def get(ref, _date = nil, _opts = {})
+      Util.warn "(#{ref}) Fetching from OpenLibrary ..."
+
+      resp = request_api ref
+      unless resp
+        Util.warn "(#{ref}) Not found."
+        return
+      end
+
+      bib = Parser.parse resp
+      Util.warn "(#{ref}) Found: `#{bib.docidentifier.first.id}`"
+      bib
+    end
+
+    def request_api(ref)
+      /ISBN\s*(?<isbn>\w+)/ =~ ref
+      return unless isbn
+
+      uri = URI "#{ENDPOINT}#{isbn}.json"
+      response = Net::HTTP.get_response uri
+      return unless response.is_a? Net::HTTPSuccess
+
+      data = JSON.parse response.body
+      return unless data["records"]&.any?
+
+      data["records"].first.last
+    end
+  end
+end

data/lib/relaton_isbn/parser.rb

@@ -0,0 +1,67 @@
+module RelatonIsbn
+  #
+  # OpenLibrary document parser.
+  #
+  class Parser
+    ATTRS = %i[title docid link contributor date place].freeze
+
+    def initialize(doc)
+      @doc = doc
+    end
+
+    def self.parse(doc)
+      new(doc).parse
+    end
+
+    def parse
+      args = ATTRS.each_with_object({}) { |a, h| h[a] = send(a) }
+      RelatonBib::BibliographicItem.new(**args)
+    end
+
+    private
+
+    def title
+      t = [RelatonBib::TypedTitleString.new(content: @doc["data"]["title"], type: "main")]
+      if @doc["data"]["subtitle"]
+        t << RelatonBib::TypedTitleString.new(content: @doc["data"]["subtitle"], type: "subtitle")
+      end
+      t
+    end
+
+    def docid
+      isbn = @doc["details"]["bib_key"].split(":").last
+      [RelatonBib::DocumentIdentifier.new(id: isbn, type: "ISBN", primary: true)]
+    end
+
+    def link
+      [RelatonBib::TypedUri.new(content: @doc["recordURL"], type: "src")]
+    end
+
+    def contributor
+      create_authors + creaate_publishers
+    end
+
+    def create_authors
+      @doc["data"]["authors"].map do |a|
+        name = RelatonBib::FullName.new completename: RelatonBib::LocalizedString.new(a["name"])
+        entity = RelatonBib::Person.new name: name, url: a["url"]
+        RelatonBib::ContributionInfo.new entity: entity, role: [{ type: "author" }]
+      end
+    end
+
+    def creaate_publishers
+      @doc["data"]["publishers"].map do |p|
+        entity = RelatonBib::Organization.new name: RelatonBib::LocalizedString.new(p["name"])
+        RelatonBib::ContributionInfo.new entity: entity, role: [{ type: "publisher" }]
+      end
+    end
+
+    def date
+      @doc["publishDates"].map { RelatonBib::BibliographicDate.new type: "published", on: _1 }
+    end
+
+    def place
+      @doc["data"]["publish_places"]&.map { RelatonBib::Place.new city: _1["name"] }
+    end
+  end
+end

data/lib/relaton_isbn/processor.rb

@@ -0,0 +1,58 @@
+require "relaton/processor"
+
+module RelatonIsbn
+  class Processor < Relaton::Processor
+    attr_reader :idtype
+
+    def initialize # rubocop:disable Lint/MissingSuper
+      @short = :relaton_isbn
+      @prefix = "ISBN"
+      @defaultprefix = /^ISBN\s/
+      @idtype = "ISBN"
+      @datasets = %w[]
+    end
+
+    # @param code [String]
+    # @param date [String, nil] year
+    # @param opts [Hash]
+    # @return [RelatonBib::BibliographicItem]
+    def get(code, date, opts)
+      ::RelatonIsbn::OpenLibrary.get(code, date, opts)
+    end
+
+    #
+    # @param [String] source source name (bipm-data-outcomes, bipm-si-brochure,
+    #   rawdata-bipm-metrologia)
+    # @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 [RelatonBib::BibliographicItem]
+    def from_xml(xml)
+      ::RelatonBib::XMLParser.from_xml xml
+    end
+
+    # @param hash [Hash]
+    # @return [RelatonBib::BibliographicItem]
+    def hash_to_bib(hash)
+      ::RelatonBib::BibliographicItem.from_hash hash
+    end
+
+    # Returns hash of XML grammar
+    # @return [String]
+    def grammar_hash
+      @grammar_hash ||= ::RelatonIsbn.grammar_hash
+    end
+
+    #
+    # Remove index file
+    #
+    # def remove_index_file
+    # end
+  end
+end

data/lib/relaton_isbn/util.rb

@@ -0,0 +1,9 @@
+module RelatonIsbn
+  module Util
+    extend RelatonBib::Util
+
+    def self.logger
+      RelatonIsbn.configuration.logger
+    end
+  end
+end

data/lib/relaton_isbn/version.rb

@@ -0,0 +1,3 @@
+module RelatonIsbn
+  VERSION = "1.17.0".freeze
+end

data/lib/relaton_isbn.rb

@@ -0,0 +1,17 @@
+require "net/http"
+require "relaton_bib"
+require_relative "relaton_isbn/version"
+require_relative "relaton_isbn/config"
+require_relative "relaton_isbn/util"
+require_relative "relaton_isbn/parser"
+require_relative "relaton_isbn/open_library"
+
+module RelatonIsbn
+  module_function
+
+  # Returns hash of XML reammar
+  # @return [String]
+  def grammar_hash
+    Digest::MD5.hexdigest RelatonIsbn::VERSION + RelatonBib::VERSION # grammars
+  end
+end

data/sig/relaton_isbn.rbs

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

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: relaton-isbn
+version: !ruby/object:Gem::Version
+  version: 1.17.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: relaton-bib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+description: 'RelatonIsbn: retrieve publications by ISBN for bibliographic use using
+  the BibliographicItem model'
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.adoc
+- Rakefile
+- lib/relaton_isbn.rb
+- lib/relaton_isbn/config.rb
+- lib/relaton_isbn/open_library.rb
+- lib/relaton_isbn/parser.rb
+- lib/relaton_isbn/processor.rb
+- lib/relaton_isbn/util.rb
+- lib/relaton_isbn/version.rb
+- sig/relaton_isbn.rbs
+homepage: https://github.com/relaton/relaton-isbn
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/relaton/relaton-isbn
+  source_code_uri: https://github.com/relaton/relaton-isbn
+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: 'RelatonIsbn: retrieve publications by ISBN for bibliographic use using the
+  BibliographicItem model'
+test_files: []