relaton-bipm 1.16.1 → 1.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24d544bd3daad314cd7af5b723c53765c4dfaedc5fe1cd56bfd4352dd9901a72
-  data.tar.gz: '0309c87fe248963a2fec6d1a9fd1eadfc99158a55e8e6a8e9fdf7cc00f3e6add'
+  metadata.gz: ced155bf740bb8a1bb34fffc1c58bb864b753236abeb8a406aef9a2a509835c2
+  data.tar.gz: 7111b47d1617da91a47919336d2bc665de041e3ae109d06e0182ea9ad01ff140
 SHA512:
-  metadata.gz: a125b70df0a8cfaafb3acb4adc7fbf8dc429c05208def6658927302e9880009bc6a9d471c24ca7c0cf5257484297c75ad020d282eafa99cad1230e9048957eba
-  data.tar.gz: b7041bf466e72998494a9ebeeec12b7d26ca504a47125e2b47e4903a996a4756c6f04926fc5818f9cffb61601be2ef2e91b6e8a25b20b2c294cd7e45996cc6ff
+  metadata.gz: d48462fd26483e16041580591fd0b3b5e0f58bdea4058dab03210606e1f49f6ddaddfe0b69a9e4c1e930496b56580315f2ad14644a1fb04abae4d991009c0004
+  data.tar.gz: 2e8ac7afb0fda2c8f8f1acf1beb00c3870ab8941250f124e718e3b6f251d67dfc69442251c4ec6965c4e5a895d90d7da8e5354976152a87691e11980e832da0a

data/README.adoc

@@ -187,76 +187,87 @@ Recommendation JCRB/43-1 (2021) / Recommandation JCRB/43-1 (2021)
 JCRB REC JCRB/43-1 (2021)
 ----
 
-==== Examples
+=== 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 `RelatonBipm.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_bipm'
 => true
 
+RelatonBipm.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+==== Examples
+
+[source,ruby]
+----
 # get BIPM brochure
 item = RelatonBipm::BipmBibliography.get "BIPM SI Brochure"
-[relaton-bipm] ("BIPM SI Brochure") fetching...
-[relaton-bipm] ("BIPM SI Brochure") found BIPM SI Brochure
+[relaton-bipm] (BIPM SI Brochure) fetching...
+[relaton-bipm] (BIPM SI Brochure) found `BIPM SI Brochure`
 => #<RelatonBipm::BipmBibliographicItem:0x007ffb83982fe8
 ...
 
 # get BIPM Metrologia page
 bib = RelatonBipm::BipmBibliography.get "BIPM Metrologia 29 6 001"
-[relaton-bipm] ("BIPM Metrologia 29 6 001") fetching...
-[relaton-bipm] ("BIPM Metrologia 29 6 001") found Metrologia 29 6 001
+[relaton-bipm] (BIPM Metrologia 29 6 001) fetching...
+[relaton-bipm] (BIPM Metrologia 29 6 001) found `Metrologia 29 6 001`
 => #<RelatonBipm::BipmBibliographicItem:0x007f8857f94d40
 ...
 
 # get CGPM meetings
 RelatonBipm::BipmBibliography.get "CGPM 1st Meeting (1889)"
-[relaton-bipm] ("CGPM 1st Meeting (1889)") fetching...
-[relaton-bipm] ("CGPM 1st Meeting (1889)") found CGPM 1th meeting (1889)
+[relaton-bipm] (CGPM 1st Meeting (1889)) fetching...
+[relaton-bipm] (CGPM 1st Meeting (1889)) found `CGPM 1th meeting (1889)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f7fd02aba28
 ...
 
 # get CGPM resolutions
 RelatonBipm::BipmBibliography.get "CGPM RES (1889, E)"
-[relaton-bipm] ("CGPM RES (1889, E)") fetching...
-[relaton-bipm] ("CGPM RES (1889, E)") found CGPM RES (1889)
+[relaton-bipm] (CGPM RES (1889, E)) fetching...
+[relaton-bipm] (CGPM RES (1889, E)) found `CGPM RES (1889)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f80421f93d8
 ...
 
 RelatonBipm::BipmBibliography.get "CGPM Resolution (1889)"
-[relaton-bipm] ("CGPM Resolution (1889)") fetching...
-[relaton-bipm] ("CGPM Resolution (1889)") found CGPM RES (1889)
+[relaton-bipm] (CGPM Resolution (1889)) fetching...
+[relaton-bipm] (CGPM Resolution (1889)) found `CGPM RES (1889)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f8017f60c18
 ...
 
 RelatonBipm::BipmBibliography.get "CGPM Résolution (1889)"
-[relaton-bipm] ("CGPM Résolution (1889)") fetching...
-[relaton-bipm] ("CGPM Résolution (1889)") found CGPM RES (1889)
+[relaton-bipm] (CGPM Résolution (1889)) fetching...
+[relaton-bipm] (CGPM Résolution (1889)) found `CGPM RES (1889)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f8017f492e8
 ...
 
 # get CIPM decision by year and decision number
 RelatonBipm::BipmBibliography.get "BIPM Decision CIPM/101-1 (2012)"
-[relaton-bipm] ("BIPM Decision CIPM/101-1 (2012)") fetching...
-[relaton-bipm] ("BIPM Decision CIPM/101-1 (2012)") found CIPM DECN 101-1 (2012)
+[relaton-bipm] (BIPM Decision CIPM/101-1 (2012)) fetching...
+[relaton-bipm] (BIPM Decision CIPM/101-1 (2012)) found `CIPM DECN 101-1 (2012)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f8017f2bd88
 ...
 
 RelatonBipm::BipmBibliography.get "BIPM DECN CIPM/101-1 (2012, E)"
-[relaton-bipm] ("BIPM DECN CIPM/101-1 (2012, E)") fetching...
-[relaton-bipm] ("BIPM DECN CIPM/101-1 (2012, E)") found CIPM DECN 101-1 (2012)
+[relaton-bipm] (BIPM DECN CIPM/101-1 (2012, E)) fetching...
+[relaton-bipm] (BIPM DECN CIPM/101-1 (2012, E)) found `CIPM DECN 101-1 (2012)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f8017f39438
 ...
 
 # get CIPM recommendation
 RelatonBipm::BipmBibliography.get "CIPM Recommendation 1 (2005)"
-[relaton-bipm] ("CIPM Recommendation 1 (2005)") fetching...
-[relaton-bipm] ("CIPM Recommendation 1 (2005)") found CIPM REC 1 (2005)
+[relaton-bipm] (CIPM Recommendation 1 (2005)) fetching...
+[relaton-bipm] (CIPM Recommendation 1 (2005)) found `CIPM REC 1 (2005)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f8017f31da0
 ...
 
 RelatonBipm::BipmBibliography.get "CIPM REC 1 (2005, FR)"
-[relaton-bipm] ("CIPM REC 1 (2005, FR)") fetching...
-[relaton-bipm] ("CIPM REC 1 (2005, FR)") found CIPM REC 1 (2005)
+[relaton-bipm] (CIPM REC 1 (2005, FR)) fetching...
+[relaton-bipm] (CIPM REC 1 (2005, FR)) found `CIPM REC 1 (2005)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f80422100d8
 ...
 ----

data/lib/relaton_bipm/bipm_bibliographic_item.rb

@@ -27,12 +27,12 @@ module RelatonBipm
     # @param structuredidentifier [RelatonBipm::StructuredIdentifier]
     def initialize(**args) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
       if args[:docstatus] && !STATUSES.include?(args[:docstatus].stage.value)
-        Util.warn "Warning: invalid docstatus: `#{args[:docstatus].stage.value}`. " \
+        Util.warn "WARNING: invalid docstatus: `#{args[:docstatus].stage.value}`. " \
                   "It should be one of: `#{STATUSES.join('`, `')}`"
       end
 
       if args[:si_aspect] && !SI_ASPECTS.include?(args[:si_aspect])
-        Util.warn "Warning: invalid si_aspect: `#{args[:si_aspect]}``. " \
+        Util.warn "WARNING: invalid si_aspect: `#{args[:si_aspect]}``. " \
                   "It should be one of: `#{SI_ASPECTS.join('`, `')}`"
       end
 

data/lib/relaton_bipm/bipm_bibliography.rb

@@ -9,9 +9,9 @@ module RelatonBipm
       # @param text [String]
       # @return [RelatonBipm::BipmBibliographicItem]
       def search(text, _year = nil, _opts = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-        Util.warn "(#{text}) fetching..."
+        Util.warn "(#{text}) fetching from Relaton repository ..."
         ref = text.sub(/^BIPM\s/, "")
-        item = get_bipm(ref, magent)
+        item = get_bipm ref
         unless item
           Util.warn "(#{text}) not found."
           return
@@ -24,32 +24,34 @@ module RelatonBipm
       end
 
       # @return [Mechanize]
-      def magent # rubocop:disable Metrics/MethodLength
-        a = Mechanize.new
-        a.request_headers = {
-          "Accept" => "text/html,application/xhtml+xml,application/xml;q=0.9," \
-                      "image/avif,image/webp,image/apng," \
-                      "*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
-          "Accept-Encoding" => "gzip, deflate, br",
-          "Accept-Language" => "en-US,en;q=0.9,ru-RU;q=0.8,ru;q=0.7",
-          "Cache-Control" => "max-age=0",
-          "Upgrade-Insecure-Requests" => "1",
-        }
-        a.user_agent_alias = Mechanize::AGENT_ALIASES.map(&:first).shuffle.first
-        # a.user_agent_alias = "Mac Safari"
-        a
-      end
+      # def magent # rubocop:disable Metrics/MethodLength
+      #   a = Mechanize.new
+      #   a.request_headers = {
+      #     "Accept" => "text/html,application/xhtml+xml,application/xml;q=0.9," \
+      #                 "image/avif,image/webp,image/apng," \
+      #                 "*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
+      #     "Accept-Encoding" => "gzip, deflate, br",
+      #     "Accept-Language" => "en-US,en;q=0.9,ru-RU;q=0.8,ru;q=0.7",
+      #     "Cache-Control" => "max-age=0",
+      #     "Upgrade-Insecure-Requests" => "1",
+      #   }
+      #   a.user_agent_alias = Mechanize::AGENT_ALIASES.map(&:first).shuffle.first
+      #   # a.user_agent_alias = "Mac Safari"
+      #   a
+      # end
 
+      #
       # @param reference [String]
-      # @param agent [Mechanize]
+      #
       # @return [RelatonBipm::BipmBibliographicItem]
-      def get_bipm(reference, agent) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      #
+      def get_bipm(reference) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         ref_id = Id.new reference
         rows = index.search { |r| ref_id == r[:id] }
         return unless rows.any?
 
         url = "#{GH_ENDPOINT}#{rows.first[:file]}"
-        resp = agent.get url
+        resp = Mechanize.new.get url
         return unless resp.code == "200"
 
         yaml = RelatonBib.parse_yaml resp.body, [Date]

data/lib/relaton_bipm/id_parser.rb

@@ -76,7 +76,7 @@ module RelatonBipm
     def initialize(id)
       @id = Parser.new.parse(id)
     rescue Parslet::ParseFailed => e
-      Util.warn "Incorrect reference: `#{id}`"
+      Util.warn "WARNING: Incorrect reference: `#{id}`"
       # warn "[relaton-bipm] #{e.parse_failure_cause.ascii_tree}"
       raise RelatonBib::RequestError, e
     end

data/lib/relaton_bipm/version.rb

@@ -1,3 +1,3 @@
 module RelatonBipm
-  VERSION = "1.16.1".freeze
+  VERSION = "1.16.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bipm
 version: !ruby/object:Gem::Version
-  version: 1.16.1
+  version: 1.16.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-20 00:00:00.000000000 Z
+date: 2023-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday