relaton 1.12.2 → 1.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d1245a5e26b3bf22fef51b47397cf229876b56e026e1342a80e3da129c44fad
-  data.tar.gz: d13c8549f75408f841ed17f6781d7b33b6cd94586b6e8775928481a045b5c0c1
+  metadata.gz: 6e6ac176313825ccd3328f85d357e92a0316dc40af8174f2af9d021ddf00b4e6
+  data.tar.gz: 031ab61832bdca69327a65aabd6563c80798488e3292fb272420470bd44e1bb1
 SHA512:
-  metadata.gz: 7bcdd489f5db390837007665cac0e796ca37e3791b42c9d4eae575b04b30555882b0ad07bb0b9f8cf1c2dec03d9a51a61374a4a9b7c1cc907c9cc6f988ec7a8b
-  data.tar.gz: 821809065cd6837638ae14a029f9a6eaad48f9d4cfd1a4d90470e6acd3dbaffa9bc8590fdbb81ed8f9193e91bfe3e7f46bbbb1eee941e7bc8decd7406d3dab54
+  metadata.gz: db39780d4edf4de3d7d31b150b5a08161c68f9aa62660e0e55d01bde131e997ca3431204e1f4e6db3826c7183a0df032cb09cda57ae998e681535c10d53c0c5b
+  data.tar.gz: bfdb82eb750071772b200ac44d50a5d95019033d4c748483e7bb378b1355c32f8facb0184790da68133dc36018f4386766e6b2739ca9df3d0242e884ba1405ed

data/.github/workflows/rake.yml

@@ -10,23 +10,5 @@ on:
 
 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' ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        experimental: [ false ]
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
+    uses: relaton/support/.github/workflows/rake.yml@master
 
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - run: bundle exec rake

data/docs/README.adoc

@@ -62,6 +62,24 @@ e.g. `get("ISO 19115-1", "2014", all_parts: true)` is transformed into a referen
 
 == Usage
 
+=== Configuration
+
+* `logs` - is array of log levels. Allowed values: `:info`, `:warning`, `:error`, `:debug`. Default values are `[:info, :error]`.
+* `use_api` - `true` if it needs to use an online cache, `false` inf not. Default value is `true`.
+* `api_host` - url of an online cache. Default value is https://api.relaton.org.
+
+[source,ruby]
+----
+require "relaton"
+=> true
+
+Relaton.configure do |conf|
+  conf.logs = %i[info error]
+  conf.use_api = true
+  conf.api_host = "https://api.relaton.org"
+end
+----
+
 === Create DB
 
 `Relaton::Db#new(globalcache, localcache)` creates new DB. Returns Relaton::Db instance.
@@ -71,9 +89,6 @@ e.g. `get("ISO 19115-1", "2014", all_parts: true)` is transformed into a referen
 
 [source,ruby]
 ----
-require "relaton"
-=> true
-
 # Do not cache any entries retrieved
 db = Relaton::Db.new(nil, nil)
 => #<Relaton::Db:0x007faaaba77648

data/lib/relaton/config.rb

@@ -12,13 +12,14 @@ module Relaton
   end
 
   class Configuration
-    attr_accessor :logs, :use_api
+    attr_accessor :logs, :use_api, :api_host
 
     def initialize
       @logs = %i(info error) # allowed values: :info, :warning, :error, :debug
 
       # @TODO change to true when we start using api.relaton.org
       @use_api = false
+      @api_host = "https://api.relaton.org"
     end
   end
 

data/lib/relaton/db.rb

@@ -1,10 +1,4 @@
-require "yaml"
-require_relative "registry"
-require_relative "db_cache"
-
 module Relaton
-  class RelatonError < StandardError; end
-
   class Db
     # @param global_cache [String] directory of global DB
     # @param local_cache [String] directory of local DB
@@ -24,10 +18,8 @@ module Relaton
     # @return [String, nil]
     def mv(new_dir, type: :global)
       case type
-      when :global
-        @db&.mv new_dir
-      when :local
-        @local_db&.mv new_dir
+      when :global then @db&.mv new_dir
+      when :local then @local_db&.mv new_dir
       end
     end
 
@@ -69,8 +61,7 @@ module Relaton
             end
       ref ||= code
       result = combine_doc ref, year, opts, stdclass
-      result ||= check_bibliocache(ref, year, opts, stdclass)
-      result
+      result || check_bibliocache(ref, year, opts, stdclass)
     end
 
     # @see Relaton::Db#fetch
@@ -167,11 +158,7 @@ module Relaton
     # @param key [String]
     # @return [Hash]
     def load_entry(key)
-      unless @local_db.nil?
-        entry = @local_db[key]
-        return entry if entry
-      end
-      @db[key]
+      (@local_db && @local_db[key]) || @db[key]
     end
 
     # @param key [String]
@@ -187,14 +174,52 @@ module Relaton
     def to_xml
       db = @local_db || @db || return
       Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
-        xml.documents do
-          xml.parent.add_child db.all.join(" ")
-        end
+        xml.documents { xml.parent.add_child db.all.join(" ") }
       end.to_xml
     end
 
     private
 
+    # @param (see #fetch_api)
+    # @return (see #fetch_api)
+    def fetch_doc(code, year, opts, processor)
+      if Relaton.configuration.use_api then fetch_api(code, year, opts, processor)
+      else processor.get(code, year, opts)
+      end
+    end
+
+    #
+    # @param code [String]
+    # @param year [String]
+    #
+    # @param opts [Hash]
+    # @option opts [Boolean] :all_parts If all-parts reference is required
+    # @option opts [Boolean] :keep_year If undated reference should return
+    #   actual reference with year
+    #
+    # @param processor [Relaton::Processor]
+    # @return [RelatonBib::BibliographicItem, nil]
+    def fetch_api(code, year, opts, processor)
+      url = "#{Relaton.configuration.api_host}/api/v1/document?#{params(code, year, opts)}"
+      rsp = Net::HTTP.get_response URI(url)
+      processor.from_xml rsp.body if rsp.code == "200"
+    rescue Errno::ECONNREFUSED
+      processor.get(code, year, opts)
+    end
+
+    #
+    # Make string of parametrs
+    #
+    # @param [String] code
+    # @param [String] year
+    # @param [Hash] opts
+    #
+    # @return [String]
+    #
+    def params(code, year, opts)
+      opts.merge(code: code, year: year).map { |k, v| "#{k}=#{v}" }.join "&"
+    end
+
     # @param file [String] file path
     # @param xml [String] content in XML format
     # @param text [String, nil] text to serach
@@ -221,9 +246,14 @@ module Relaton
         item.date.detect { |d| d.type == "published" && d.on(:year).to_s == year.to_s })
     end
 
+    #
+    # Look up text in the XML elements attributes and content
+    #
     # @param xml [String] content in XML format
     # @param text [String, nil] text to serach
+    #
     # @return [Boolean]
+    #
     def match_xml_text(xml, text)
       %r{((?<attr>=((?<apstr>')|"))|>).*?#{text}.*?(?(<attr>)(?(<apstr>)'|")|<)}mi.match?(xml)
     end
@@ -258,10 +288,9 @@ module Relaton
 
       doc = @registry.processors[stdclass].hash_to_bib docid: { id: code }
       ref = refs[0]
-      updates = check_bibliocache(ref, year, opts, stdclass)
+      updates = check_bibliocache(refs[0], year, opts, stdclass)
       if updates
-        doc.relation << RelatonBib::DocumentRelation.new(bibitem: updates,
-                                                         type: "updates")
+        doc.relation << RelatonBib::DocumentRelation.new(bibitem: updates, type: "updates")
       end
       divider = stdclass == :relaton_itu ? " " : "/"
       refs[1..].each_with_object(doc) do |c, d|
@@ -403,7 +432,8 @@ module Relaton
         return entry
       end
 
-      bib = net_retry(code, year, opts, stdclass, opts.fetch(:retries, 1))
+      processor = @registry.processors[stdclass]
+      bib = net_retry(code, year, opts, processor, opts.fetch(:retries, 1))
       bib_id = bib&.docidentifier&.first&.id
 
       # when docid doesn't match bib's id then return a reference to bib's id
@@ -418,13 +448,27 @@ module Relaton
       @semaphore.synchronize { args[:db][args[:id]] ||= entry }
     end
 
+    #
+    # @param code [String]
+    # @param year [String]
+    #
+    # @param opts [Hash]
+    # @option opts [Boolean] :all_parts If all-parts reference is required
+    # @option opts [Boolean] :keep_year If undated reference should return
+    #   actual reference with year
+    #
+    # @param processor [Relaton::Processor]
+    # @param retries [Integer] remain Number of network retries
+    #
     # @raise [RelatonBib::RequestError]
-    def net_retry(code, year, opts, stdclass, retries)
-      @registry.processors[stdclass].get(code, year, opts)
+    # @return [RelatonBib::BibliographicItem]
+    #
+    def net_retry(code, year, opts, processor, retries)
+      fetch_doc code, year, opts, processor
     rescue RelatonBib::RequestError => e
       raise e unless retries > 1
 
-      net_retry(code, year, opts, stdclass, retries - 1)
+      net_retry(code, year, opts, processor, retries - 1)
     end
 
     # @param bib [RelatonBib::BibliographicItem,
@@ -437,11 +481,7 @@ module Relaton
     #   RelatonOmg::OmgBibliographicItem, RelatonW3c::W3cBibliographicItem]
     # @return [String] XML or "not_found mm-dd-yyyy"
     def bib_entry(bib)
-      if bib.respond_to? :to_xml
-        bib.to_xml(bibdata: true)
-      else
-        "not_found #{Date.today}"
-      end
+      bib.respond_to?(:to_xml) ? bib.to_xml(bibdata: true) : "not_found #{Date.today}"
     end
 
     # @param dir [String, nil] DB directory

data/lib/relaton/db_cache.rb

@@ -10,9 +10,7 @@ module Relaton
     def initialize(dir, ext = "xml")
       @dir = dir
       @ext = ext
-      FileUtils::mkdir_p @dir
-      # file_version = "#{@dir}/version"
-      # set_version # unless File.exist? file_version
+      FileUtils::mkdir_p dir
     end
 
     # Move caches to anothe dir
@@ -102,10 +100,10 @@ module Relaton
 
     # Returns all items
     # @return [Array<String>]
-    def all
+    def all(&block)
       Dir.glob("#{@dir}/**/*.{xml,yml,yaml}").sort.map do |f|
         content = File.read(f, encoding: "utf-8")
-        block_given? ? yield(f, content) : content
+        block ? yield(f, content) : content
       end
     end
 
@@ -113,30 +111,19 @@ module Relaton
     # @param key [String]
     def delete(key)
       file = filename key
-      f = search_ext(file)
+      f = search_ext file
       File.delete f if f
     end
 
     # Check if version of the DB match to the gem grammar hash.
     # @param fdir [String] dir pathe to flover cache
-    # @return [TrueClass, FalseClass]
+    # @return [Boolean]
     def check_version?(fdir)
       version_dir = "#{fdir}/version"
       return false unless File.exist? version_dir
 
       v = File.read version_dir, encoding: "utf-8"
-      v.strip == grammar_hash(fdir)
-    end
-
-    # Set version of the DB to the gem grammar hash.
-    # @param fdir [String] dir pathe to flover cache
-    # @return [Relaton::DbCache]
-    def set_version(fdir)
-      file_version = "#{fdir}/version"
-      unless File.exist? file_version
-        file_safe_write file_version, grammar_hash(fdir)
-      end
-      self
+      v.strip == self.class.grammar_hash(fdir)
     end
 
     # if cached reference is undated, expire it after 60 days
@@ -150,15 +137,6 @@ module Relaton
       year || Date.today - date < 60
     end
 
-    protected
-
-    # @param fdir [String] dir pathe to flover cache
-    # @return [String]
-    def grammar_hash(fdir)
-      type = fdir.split("/").last
-      Relaton::Registry.instance.by_type(type)&.grammar_hash
-    end
-
     # Reads file by a key
     #
     # @param key [String]
@@ -170,19 +148,16 @@ module Relaton
       File.read(f, encoding: "utf-8")
     end
 
-    private
-
-    # Check if a file content is redirection
-    #
-    # @prarm value [String] file content
-    # @return [String, NilClass] redirection code or nil
-    def redirect?(value)
-      %r{redirection\s(?<code>.*)} =~ value
-      code
+    # @param fdir [String] dir pathe to flover cache
+    # @return [String]
+    def self.grammar_hash(fdir)
+      type = fdir.split("/").last
+      Relaton::Registry.instance.by_type(type)&.grammar_hash
     end
 
-    # Return item's file name
-    # @param key [String]
+    private
+
+    # @param value [String]
     # @return [String]
     def filename(key)
       prefcode = key.downcase.match(/^(?<prefix>[^(]+)\((?<code>[^)]+)/)
@@ -210,13 +185,31 @@ module Relaton
       end
     end
 
-    # Return item's subdir
+    # Set version of the DB to the gem grammar hash.
+    # @param fdir [String] dir pathe to flover cache
+    def set_version(fdir)
+      file_version = "#{fdir}/version"
+      unless File.exist? file_version
+        file_safe_write file_version, self.class.grammar_hash(fdir)
+      end
+    end
+
+    # Return item's file name
     # @param key [String]
     # @return [String]
     def prefix(key)
       key.downcase.match(/^[^(]+(?=\()/).to_s
     end
 
+    # Check if a file content is redirection
+    #
+    # @prarm value [String] file content
+    # @return [String, NilClass] redirection code or nil
+    def redirect?(value)
+      %r{redirection\s(?<code>.*)} =~ value
+      code
+    end
+
     # @param file [String]
     # @content [String]
     def file_safe_write(file, content)
@@ -225,37 +218,5 @@ module Relaton
         f.write content
       end
     end
-
-    class << self
-      private
-
-      def global_bibliocache_name
-        "#{Dir.home}/.relaton/cache"
-      end
-
-      def local_bibliocache_name(cachename)
-        return nil if cachename.nil?
-
-        cachename = "relaton" if cachename.empty?
-        "#{cachename}/cache"
-      end
-
-      public
-
-      # Initialse and return relaton instance, with local and global cache names
-      # local_cache: local cache name; none created if nil; "relaton" created
-      # if empty global_cache: boolean to create global_cache
-      # flush_caches: flush caches
-      def init_bib_caches(opts) # rubocop:disable Metrics/CyclomaticComplexity
-        globalname = global_bibliocache_name if opts[:global_cache]
-        localname = local_bibliocache_name(opts[:local_cache])
-        localname = "relaton" if localname&.empty?
-        if opts[:flush_caches]
-          FileUtils.rm_rf globalname unless globalname.nil?
-          FileUtils.rm_rf localname unless localname.nil?
-        end
-        Relaton::Db.new(globalname, localname)
-      end
-    end
   end
 end

data/lib/relaton/version.rb

@@ -1,3 +1,3 @@
 module Relaton
-  VERSION = "1.12.2".freeze
+  VERSION = "1.12.3".freeze
 end

data/lib/relaton.rb

@@ -1,5 +1,6 @@
 require "relaton/util"
 require "relaton/config"
+require "yaml"
 
 require "relaton/workers_pool"
 require "relaton/db"

data/spec/relaton/db_cache_spec.rb

@@ -6,8 +6,8 @@ RSpec.describe Relaton::DbCache do
     cache_path = File.expand_path("~/.relaton/cache")
     FileUtils.mv cache_path, "relaton1/cache", force: true
     FileUtils.rm_rf %w(relaton)
-    Relaton::DbCache.init_bib_caches(
-      global_cache: true, local_cache: "", flush_caches: true
+    Relaton::Db.init_bib_caches(
+      global_cache: true, local_cache: "", flush_caches: true,
     )
     expect(File.exist?(cache_path)).to be true
     expect(File.exist?("relaton")).to be true

data/spec/relaton/registry_spec.rb

@@ -2,7 +2,7 @@ RSpec.describe Relaton::Registry do
   it "outputs backend not present" do
     stub_const "Relaton::Registry::SUPPORTED_GEMS", ["not_supported_gem"]
     expect { Relaton::Registry.clone.instance }.to output(
-      /backend not_supported_gem not present/
+      /backend not_supported_gem not present/,
     ).to_stderr
   end
 

data/spec/relaton_spec.rb

@@ -214,6 +214,9 @@ RSpec.describe Relaton::Db do
       .at_most :once
     allow(File).to receive(:write).and_call_original
     VCR.use_cassette "ogc_19_025r1" do
+      expect(File).to receive(:exist?).with("/Users/andrej/.relaton/ogc/bibliography.json").and_return(false).at_most :once
+      expect(File).to receive(:exist?).with("/Users/andrej/.relaton/ogc/etag.txt").and_return(false).at_most :once
+      allow(File).to receive(:exist?).and_call_original
       bib = @db.fetch "OGC 19-025r1", nil, {}
       expect(bib).to be_instance_of RelatonOgc::OgcBibliographicItem
     end
@@ -396,7 +399,7 @@ RSpec.describe Relaton::Db do
   context "version control" do
     before(:each) { @db.save_entry "iso(test_key)", "<bibitem><title>test_value</title></bibitem>" }
 
-    it "shoudn't clear cacho if version isn't changed" do
+    it "shoudn't clear cache if version isn't changed" do
       testcache = @db.instance_variable_get :@db
       expect(testcache.all).to be_any
       testcache = @db.instance_variable_get :@local_db
@@ -414,4 +417,38 @@ RSpec.describe Relaton::Db do
       expect(File.exist?("testcache2/iso/version")).to eq false
     end
   end
+
+  context "api.relaton.org" do
+    before(:each) do
+      Relaton.configure do |config|
+        config.use_api = true
+        # config.api_host = "http://0.0.0.0:9292"
+      end
+    end
+
+    after(:each) do
+      Relaton.configure do |config|
+        config.use_api = false
+      end
+    end
+
+    it "get document" do
+      VCR.use_cassette "api_relaton_org" do
+        bib = @db.fetch "ISO 19115-2", "2019"
+        expect(bib).to be_instance_of RelatonIsoBib::IsoBibliographicItem
+      end
+    end
+
+    it "if unavailable then get document directly" do
+      expect(Net::HTTP).to receive(:get_response).and_wrap_original do |m, *args|
+        raise Errno::ECONNREFUSED if args[0].host == "api.relaton.org"
+
+        m.call(*args)
+      end.at_least :once
+      VCR.use_cassette "api_relaton_org_unavailable" do
+        bib = @db.fetch "ISO 19115-2", "2019"
+        expect(bib).to be_instance_of RelatonIsoBib::IsoBibliographicItem
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -24,6 +24,10 @@ end
 
 require "relaton"
 
+Relaton.configure do |config|
+  config.use_api = false
+end
+
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
   config.example_status_persistence_file_path = ".rspec_status"

data/spec/vcr_cassetes/3gpp_tr_00_01u_umts_3_0_0.yml

@@ -23,7 +23,7 @@ http_interactions:
       Connection:
       - keep-alive
       Content-Length:
-      - '746'
+      - '754'
       Cache-Control:
       - max-age=300
       Content-Security-Policy:
@@ -31,7 +31,7 @@ http_interactions:
       Content-Type:
       - text/plain; charset=utf-8
       Etag:
-      - W/"ba4b443468f355962dc7524aa69c4ad80bbb98e840d6137fe420b6fa3fccf2d0"
+      - W/"bbd7f0c87384dd6862c84526ceedcbe809814a4681ced8f1e2a03507a6d36cf4"
       Strict-Transport-Security:
       - max-age=31536000
       X-Content-Type-Options:
@@ -41,29 +41,29 @@ http_interactions:
       X-Xss-Protection:
       - 1; mode=block
       X-Github-Request-Id:
-      - 7D28:10C50:1BF854C:1DDFC0B:62BDDA6B
+      - E706:0D55:162F27:183FAB:62E93CAD
       Accept-Ranges:
       - bytes
       Date:
-      - Thu, 30 Jun 2022 17:16:27 GMT
+      - Tue, 02 Aug 2022 15:03:10 GMT
       Via:
       - 1.1 varnish
       X-Served-By:
-      - cache-vie6348-VIE
+      - cache-vie6374-VIE
       X-Cache:
       - MISS
       X-Cache-Hits:
       - '0'
       X-Timer:
-      - S1656609387.047148,VS0,VE235
+      - S1659452590.893199,VS0,VE221
       Vary:
       - Authorization,Accept-Encoding,Origin
       Access-Control-Allow-Origin:
       - "*"
       X-Fastly-Request-Id:
-      - 93a267346ed97c52087b05f16495084f70b848e8
+      - 76ef6b332e38b12c4fefd91589469bd40336b4f5
       Expires:
-      - Thu, 30 Jun 2022 17:21:27 GMT
+      - Tue, 02 Aug 2022 15:08:10 GMT
       Source-Age:
       - '0'
     body:
@@ -94,12 +94,13 @@ http_interactions:
             - 3rd Generation Partnership Project
             abbreviation: 3GPP
             contact:
-            - street:
-              - c/o ETSI 650, route des Lucioles
-              - 3GPP Mobile Competence Centre
-              city: Sophia Antipolis Cedex
-              country: France
-              postcode: '06921'
+            - address:
+                street:
+                - c/o ETSI 650, route des Lucioles
+                - 3GPP Mobile Competence Centre
+                city: Sophia Antipolis Cedex
+                country: France
+                postcode: '06921'
           role:
           - author
           - publisher
@@ -127,7 +128,7 @@ http_interactions:
             value: withdrawn
         place:
         - Sophia Antipolis Cedex, France
-        fetched: '2022-06-15'
+        fetched: '2022-07-22'
         doctype: TR
         editorialgroup:
         - name: SMG5
@@ -143,5 +144,5 @@ http_interactions:
           freeze_stage3_meeting: SMG-28
           close_meeting: SP-28
           project_end: '1999-02-12'
-  recorded_at: Thu, 30 Jun 2022 17:16:27 GMT
+  recorded_at: Tue, 02 Aug 2022 15:03:10 GMT
 recorded_with: VCR 6.1.0