relaton-isbn 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67f72a126942d761c281807d95cfb1c4feefb68a00029f3d284cd19d77022288
-  data.tar.gz: fd31af74cfbaca0480129f4aa3f02e3cc4761022d2c3f2b8cb46c1278d46dd40
+  metadata.gz: a40299890b8c876a1397a66412981b29dd420e55f469b0d1d751f3ecfe76ad0a
+  data.tar.gz: f6f18a46d654dc22fa0cdac813c023904b7a622b483f4ae9127c1e350a2f546b
 SHA512:
-  metadata.gz: 5d199ef47b949e0fdeec3b6fa2d43fe93e136faef853e6ab1cfa45e26378f2b4bdd2e308813f31eec60a60714ded305e85f9d67105b5224e03b92a4072f3feac
-  data.tar.gz: 68b8bb3a2a2ea06f687a984145dedde9a782bcb9979e4286ba17bbcad4bc9a039942efa4b20313d98fe765d0c2cd73cff2e4b2fe6baffa1113ec345986c933aa
+  metadata.gz: ebc9da4bc8e27e6a3b5c9f664dba1db1e878e7b059af03eae7c19de912ada3a31f82364327e886fae55da77ce60441fc5b07bd4d83a23189b68371892857ea41
+  data.tar.gz: 557d400855efa4cb4ca264860ba525d1b0bbed5c2002788ad5d8bd41cbc70b4571431addf8c57f0e492d43969f4f7c606834afb77934b85258dce6440bb892ef

data/README.adoc

@@ -11,7 +11,7 @@ image:https://img.shields.io/github/commits-since/relaton/relaton-isbn/latest.sv
 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
+You can use it to retrieve metadata of Standards from https://openlibrary.org, and
 access such metadata through the `BibliographicItem` object.
 
 == Installation
@@ -53,20 +53,80 @@ RelatonIsbn.configure do |config|
 end
 ----
 
-=== Retrieving items of known type using OpenLibrary API
+=== Retrieving bibliographic items 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.
+To retrieve bibliographic items, use `RelatonIsbn::OpenLibrary.get` method with ISBN-10 or ISBN-13 as an argument. Prefix `ISBN` and hyphens are optional. The method returns `RelatonBib::BibliographicItem` object.
 
 [source,ruby]
 ----
-# get document by ISBN
-RelatonIsbn::OpenLibrary.get "ISBN 9780120644810"
+# get document by ISBN-13
+> bibitem = RelatonIsbn::OpenLibrary.get "ISBN 978-0-12-064481-0"
 [relaton-isbn] (ISBN 9780120644810) Fetching from OpenLibrary ...
 [relaton-isbn] (ISBN 9780120644810) Found: `9780120644810`
 => #<RelatonBib::BibliographicItem:0x0000000113889258
 ...
+
+# get document by ISBN-10
+> RelatonIsbn::OpenLibrary.get "0120644819"
+[relaton-isbn] (ISBN 0120644819) Fetching from OpenLibrary ...
+[relaton-isbn] (ISBN 0120644819) Found: `9780120644810`
+=> #<RelatonBib::BibliographicItem:0x00000001098ac960
+...
+----
+
+=== Serializing bibliographic items
+[source,ruby]
+----
+# serialize to XML
+> puts bibitem.to_xml
+<bibitem id="9780120644810" schema-version="v1.2.7">
+  <title type="main" format="text/plain">Graphics gems II</title>
+  <uri type="src">http://openlibrary.org/books/OL21119585M/Graphics_gems_II</uri>
+  <docidentifier type="ISBN" primary="true">9780120644810</docidentifier>
+  <date type="published">
+    <on>1991</on>
+  </date>
+  <contributor>
+    <role type="author"/>
+    <person>
+      <name>
+        <completename>James Arvo</completename>
+      </name>
+    </person>
+  </contributor>
+  <contributor>
+    <role type="publisher"/>
+    <organization>
+      <name>AP Professional</name>
+    </organization>
+  </contributor>
+  <place>
+    <city>Boston</city>
+  </place>
+  <place>
+    <city>London</city>
+  </place>
+</bibitem>
+
+# serialize to bibdata XML
+> puts bibitem.to_xml bibdata: true
+<bibdata schema-version="v1.2.7">
+  <title type="main" format="text/plain">Graphics gems II</title>
+  ...
+
+# serialize to hash
+> bibitem.to_hash
+=> {"schema-version"=>"v1.2.7",
+ "id"=>"9780120644810",
+ "title"=>[{"content"=>"Graphics gems II", "format"=>"text/plain", "type"=>"main"}],
+ "link"=>[{"content"=>"http://openlibrary.org/books/OL21119585M/Graphics_gems_II", "type"=>"src"}],
+ "docid"=>[{"id"=>"9780120644810", "type"=>"ISBN", "primary"=>true}],
+ "date"=>[{"type"=>"published", "value"=>"1991"}],
+ "contributor"=>
+  [{"person"=>{"name"=>{"completename"=>{"content"=>"James Arvo"}}, "url"=>"http://openlibrary.org/authors/OL2646519A/James_Arvo"}, "role"=>[{"type"=>"author"}]},
+   {"organization"=>{"name"=>[{"content"=>"AP Professional"}]}, "role"=>[{"type"=>"publisher"}]}],
+ "revdate"=>"1991",
+ "place"=>[{"city"=>"Boston"}, {"city"=>"London"}]}
 ----
 
 == Development

data/lib/relaton_isbn/isbn.rb

@@ -0,0 +1,59 @@
+module RelatonIsbn
+  class Isbn
+    #
+    # Create ISBN object.
+    #
+    # @param [String] isbn ISBN 13 number
+    #
+    def initialize(isbn)
+      @isbn = isbn&.delete("-")&.sub(/^ISBN\s/, "")
+    end
+
+    def parse
+      convert_to13
+    end
+
+    def check?
+      case @isbn
+      when /^\d{9}[\dX]$/i then check10?
+      when /^\d{13}$/ then check13?
+      else false
+      end
+    end
+
+    def check10?
+      @isbn[9] == calc_check_digit10
+    end
+
+    def check13?
+      @isbn[12] == calc_check_digit13
+    end
+
+    def calc_check_digit10
+      sum = 0
+      @isbn[..-2].chars.each_with_index do |c, i|
+        sum += c.to_i * (10 - i)
+      end
+      chk = (11 - sum % 11) % 11
+      chk == 10 ? "X" : chk.to_s
+    end
+
+    def calc_check_digit13
+      sum = 0
+      @isbn[..-2].chars.each_with_index do |c, i|
+        sum += c.to_i * (i.even? ? 1 : 3)
+      end
+      ((10 - sum % 10) % 10).to_s
+    end
+
+    def convert_to13
+      return unless check?
+
+      return @isbn if @isbn.size == 13
+
+      @isbn = "978#{@isbn}"
+      @isbn[12] = calc_check_digit13
+      @isbn
+    end
+  end
+end

data/lib/relaton_isbn/open_library.rb

@@ -7,10 +7,16 @@ module RelatonIsbn
 
     ENDPOINT = "http://openlibrary.org/api/volumes/brief/isbn/".freeze
 
-    def get(ref, _date = nil, _opts = {})
+    def get(ref, _date = nil, _opts = {}) # rubocop:disable Metrics/MethodLength
       Util.warn "(#{ref}) Fetching from OpenLibrary ..."
 
-      resp = request_api ref
+      isbn = Isbn.new(ref).parse
+      unless isbn
+        Util.warn "(#{ref}) Incorrect ISBN."
+        return
+      end
+
+      resp = request_api isbn
       unless resp
         Util.warn "(#{ref}) Not found."
         return
@@ -21,10 +27,7 @@ module RelatonIsbn
       bib
     end
 
-    def request_api(ref)
-      /ISBN\s*(?<isbn>\w+)/ =~ ref
-      return unless isbn
-
+    def request_api(isbn)
       uri = URI "#{ENDPOINT}#{isbn}.json"
       response = Net::HTTP.get_response uri
       return unless response.is_a? Net::HTTPSuccess

data/lib/relaton_isbn/version.rb

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

data/lib/relaton_isbn.rb

@@ -3,6 +3,7 @@ require "relaton_bib"
 require_relative "relaton_isbn/version"
 require_relative "relaton_isbn/config"
 require_relative "relaton_isbn/util"
+require_relative "relaton_isbn/isbn"
 require_relative "relaton_isbn/parser"
 require_relative "relaton_isbn/open_library"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-isbn
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-16 00:00:00.000000000 Z
+date: 2024-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: relaton-bib
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 1.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 1.18.0
 description: 'RelatonIsbn: retrieve publications by ISBN for bibliographic use using
   the BibliographicItem model'
 email:
@@ -39,6 +39,7 @@ files:
 - Rakefile
 - lib/relaton_isbn.rb
 - lib/relaton_isbn/config.rb
+- lib/relaton_isbn/isbn.rb
 - lib/relaton_isbn/open_library.rb
 - lib/relaton_isbn/parser.rb
 - lib/relaton_isbn/processor.rb